Global

Type Definitions

aggregateRuleType

Source:

types.js, line 30

Properties:

Name	Type	Attributes	Description
`type`	string		Should be 'caf.aggregateRule'.
`alias`	string		A local alias for the aggregate map.
`methods`	Array.<string> \| string	<optional>	The methods enabled. All enabled if this field is missing.

Type:

Object

CANameType

Source:

types.js, line 13

Properties:

Name	Type	Attributes	Description
`caOwner`	string	<optional>
`caLocalName`	string	<optional>

Type:

Object

cbType()

Source:

types.js, line 2

ctxType

Source:

types.js, line 96

Type:

Object.<string, Object>

ruleEngineType

Source:

types.js, line 8

Type:

Object

ruleType

Source:

types.js, line 40

Type:

simpleRuleType | aggregateRuleType

simpleRuleType

Source:

types.js, line 21

Properties:

Name	Type	Attributes	Description
`type`	string		Should be 'caf.simpleRule'.
`ac`	CANameType	<optional>	Enabled CAs.
`methods`	Array.<string> \| string	<optional>	The methods enabled. All enabled if this field is missing.

Type:

Object

specDeltaType

Source:

types.js, line 85

Properties:

Name	Type	Attributes	Description
`name`	string	<optional>
`module`	string \| null	<optional>
`description`	string	<optional>
`env`	Object	<optional>
`components`	Array.<specType>	<optional>

Type:

Object

specType

Source:

types.js, line 74

Properties:

Name	Type	Attributes	Description
`name`	string
`module`	string \| null
`description`	string	<optional>
`env`	Object
`components`	Array.<specType>	<optional>

Type:

Object

tkDescArray

Source:

types.js, line 58

Type:

Array.<tokenDescriptionType> | tokenDescriptionType

tokenDescriptionType

Source:

types.js, line 45

Properties:

Name	Type	Attributes	Description
`appPublisher`	string \| null	<optional>	The publisher of the app hosting CAs. A `null` value means force the current value.
`appLocalName`	string \| null	<optional>	The name of the app in the `appPublisher` context.
`caOwner`	string \| null	<optional>	The owner of the CA.
`caLocalName`	string \| null	<optional>	The name of the CA in the owner's context.
`durationInSec`	number	<optional>	Time in sec before token expiration.

Type:

Object

tokenType

Source:

types.js, line 63

Properties:

Name	Type	Attributes	Description
`appPublisher`	string	<optional>	The publisher of the app hosting CAs.
`appLocalName`	string	<optional>	The name of the app in the `appPublisher` context.
`caOwner`	string	<optional>	The owner of the CA.
`caLocalName`	string	<optional>	The name of the CA in the owner's context.
`expiresAfter`	number	<optional>	UTC expire time in msec since 1970.

Type:

Object