Types Schema

Version 0.10.0

JSON-Schema

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

Table of Contents

Schemas

SemanticVersion

type SemanticVersion = {
  major: number
  minor: number
  patch: number
  readable: string
}
Examples

AudioProfile

type AudioProfile = 'stereo' | 'dolbyDigital5.1' | 'dolbyDigital7.1' | 'dolbyDigital5.1+' | 'dolbyDigital7.1+' | 'dolbyAtmos'
Examples

BooleanMap

type BooleanMap = {
  [property: string]: boolean
}
Examples

FlatMap

type FlatMap = {
  [property: string]: string | number | boolean
}
Examples

LocalizedString

type LocalizedString = string | object
Examples
"A simple string, with no language code"

{
  "en": "This is english",
  "es": "esto es español"
}

Details

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.


ListenResponse

type ListenResponse = {
  event: string
  listening: boolean
}
Examples

ProviderRequest

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

ProviderResponse

type ProviderResponse = {
  correlationId: string    // The id that was passed in to the event that triggered a provider method to be called

}
Examples

Timeout

type Timeout = number
Examples

Details

Defines the timeout in seconds. If the threshold for timeout is passed for any operation without a result it will throw an error.


Dimensions

type Dimensions = {
  width: number
  height: number
}
Examples

Image

type Image = {
  uri: string                                             // URI for the image. May be a relative path (e.g. ./foo/image.png) or absolute (e.g. https://foo.com/bar.png) depending on usage.
  aspectRatio: string                                     // The aspect ratio of the image
  description?: string                                    // Description of the image.
  type: 'icon' | 'poster' | 'banner' | 'splash' | 'hero'  // The type of the image.
}
Examples

Go To Top