-
Notifications
You must be signed in to change notification settings - Fork 19
TypesSchema
LaCivita, Jeremy edited this page May 26, 2022
·
7 revisions
Version The Firebolt JS Manage SDK [Alpha 4]
This document was generated from a JSON-Schema, and is intended to provide a human readable overview and examples of the methods contained in the module.
For the full schema, see the link below.
Schema |
---|
types.json |
- Schemas
type SemanticVersion = {
major: bigint
minor: bigint
patch: bigint
readable: string
}
Examples
type AudioProfile = 'stereo' | 'dolbyDigital5.1' | 'dolbyDigital7.1' | 'dolbyDigital5.1+' | 'dolbyDigital7.1+' | 'dolbyAtmos'
Examples
type BooleanMap = {
[property: string]: boolean
}
Examples
type FlatMap = {
[property: string]: string | number | boolean
}
Examples
type LocalizedString = string | object
Examples
"A simple string, with no language code"
{
"en": "This is english",
"es": "esto es español"
}
Localized string supports either a simple string
or a Map<string, string> of language codes to strings. When using a simple string
, the current preferred langauge from Localization.langauge()
is assumed.
type ListenResponse = {
event: string
listening: boolean
}
Examples
type ProviderRequest = {
correlationId: string // The id that was passed in to the event that triggered a provider method to be called
parameters?: object // The result of the provider response.
}
Examples
type ProviderResponse = {
correlationId: string // The id that was passed in to the event that triggered a provider method to be called
}
Examples
type Timeout = bigint
Examples
Defines the timeout in seconds. If the threshold for timeout is passed for any operation without a result it will throw an error.