Global

Members

---

<constant> ValidationError :number

Validation error values

Type:

• number

Properties:

Name	Type	Default	Description
NONE	number	0	No validation error
NO_FIELD	number	1	The field to validate does not exist in the descriptor
REQUIRED_FIELD	number	2	A required field was omitted
NOT_ALLOWED	number	3	A value didn't match the restricted values for this field
INVALID_VALUE	number	4	The value doesn't match the pattern allowed
INVALID_MAP	number	5	The Map value doesn't match the pattern allowed for either its keys or values

Source:

• resource.js, line 20

Type Definitions

---

AuthenticationOptions

Type:

• Object

Properties:

Name	Type	Argument	Description
strategy	string	<nullable>	'pauth' or 'oauth'
secret	string	<nullable>	base64 clientId and clientSecret
url	string	<nullable>	Override the URL to hit for authentication. Useful for providing custom endpoints to provide an access_token

Source:

• session.js, line 76

---

ClientOptions

Options for the Client.

Type:

• Object

Properties:

Name	Type	Argument	Description
directory	string		The directory to pass through to Session.
registryUri	string		The registryUri to pass through to Registry.
identityUri	string	<nullable>	Optional identityUri to pass through to Session.
token	string	<nullable>	Token to authenticate with.
tenant	string	<nullable>	Tenant to initialize with.
enableCache	boolean	<nullable>	Indicates whether to cache service descriptors in Registry.
encodeURI	encodeUri	<nullable>	Indicates whether to encode URIs before requesting in Transport. Will not re-encode existing sequences (e.g. %20 will stay as %20, but %2 will encode to %202)

Source:

• client.js, line 8

---

Criteria()

Filter on ref when a string is supplied. Filter by a custom function by supplying a function Or filter by key/value pairs in an Object

Source:

• resource_collection.js, line 488

---

TransportDefaults

Default fetch options to send with all fetch requests.

Type:

• Object

Source:

• transport.js, line 22

See:

• https://github.github.io/fetch/#options

---

Validation

Type:

• Object

Properties:

Name	Type	Description
code	ValidationError	Error code
message	string	What was invalid
typeInfo	Object	The full typeInfo from the descriptor
valid	boolean	Whether the field is valid or not

Source:

• resource.js, line 220