node-client package
Classes
| Class | Description |
|---|---|
| AuthContainer | Skygear Auth APIs. |
| BaseAPIClient | |
| CancelError | CancelError is an error to represent cancel. |
| Container | Skygear APIs container. |
| GlobalJSONContainerStorage | |
| ImageProcessingPipelineBuilder | Image processing pipeline builder. |
| MemoryStorageDriver | |
| NodeAPIClient | |
| NodeAssetContainer | Skygear Asset APIs (for Node.js). |
| NodeContainer | Skygear APIs container (for Node.js). |
| OIDCContainer | Skygear Auth OIDC client APIs. |
| SkygearError | Skygear API error. |
Functions
| Function | Description |
|---|---|
| decodeAuthResponse(r) | |
| decodeError(err) | |
| decodeIdentity(i) | |
| decodeSession(s) | |
| decodeUser(u) | |
| encodeIdentity(i) | |
| encodeUser(u) | |
| getDeviceName() | Returns name of the device. |
| isValidationError(err) | Check if the provided error indicates the server failed to validate input parameters to API. |
Interfaces
| Interface | Description |
|---|---|
| AuthorizeOptions | Auth UI authorization options |
| AuthResponse | |
| ByteArray | |
| ChallengeResponse | |
| ConfigureOptions | |
| ContainerOptions | |
| ContainerStorage | |
| CustomTokenIdentity | |
| ExtraSessionInfoOptions | |
| Identity | |
| IdentityClaims | |
| ImageProcessingPipelineBuilderResizeOptions | |
| OAuthError | OAuthError represents the oauth error response. https://tools.ietf.org/html/rfc6749#section-4.1.2.1 |
| OAuthIdentity | |
| OAuthManualAuthorizationURLOptions | |
| OAuthMobileAppAuthorizationURLOptions | |
| OAuthWebPopupAuthorizationURLOptions | |
| OAuthWebRedirectAuthorizationURLOptions | |
| PasswordIdentity | |
| PromoteOptions | Auth UI anonymous user promotion options |
| Session | |
| SessionUserAgent | |
| SSOLoginOptions | |
| StorageDriver | |
| UploadAssetOptions | |
| User | |
| ValidationError | |
| ValidationErrorCauseBase | |
| ValidationErrorExpectationDetails | |
| ValidationErrorFormatDetails | |
| ValidationErrorRangeDetails |
Variables
| Variable | Description |
|---|---|
| CANCEL | CANCEL is sentinel value for cancel. |
| defaultContainer | Default Skygear APIs container. |
| SkygearErrorNames | |
| ValidationErrorKinds | |
| VERSION |