Types Schema

---

Version 0.6.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
  • AudioProfile
  • BooleanMap
  • FlatMap
  • LocalizedString
  • ListenResponse

Schemas

SemanticVersion

type SemanticVersion = {
  major: bigint
  minor: bigint
  patch: bigint
  readable: string
}

Examples

---

AudioProfile

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

Examples

---

BooleanMap

type BooleanMap = {
}

Examples

---

FlatMap

type FlatMap = {
}

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

---