@firebolt-js/sdk
Version:
The Firebolt JS SDK
84 lines (57 loc) • 1.33 kB
Markdown
title: Types
# Types
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Types](#types)
- [AudioProfile](#audioprofile)
- [SemanticVersion](#semanticversion)
- [LocalizedString](#localizedstring)
- [FlatMap](#flatmap)
- [BooleanMap](#booleanmap)
- [Timeout](#timeout)
## Types
### AudioProfile
```typescript
AudioProfile: {
STEREO: 'stereo',
DOLBY_DIGITAL_5_1: 'dolbyDigital5.1',
DOLBY_DIGITAL_5_1_PLUS: 'dolbyDigital5.1+',
DOLBY_ATMOS: 'dolbyAtmos',
},
```
### SemanticVersion
```typescript
type SemanticVersion = {
major: number
minor: number
patch: number
readable: string
}
```
### LocalizedString
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.
```typescript
type LocalizedString = string | object
```
### FlatMap
```typescript
type FlatMap = [property: string]: string | number | boolean
```
### BooleanMap
```typescript
type BooleanMap = [property: string]: boolean
```
### Timeout
Defines the timeout in seconds. If the threshold for timeout is passed for any operation without a result it will throw an error.
```typescript
type Timeout = number
```