Sku | Detritus Client

Sku Structure, used in [Gift] and [StoreListing]

Hierarchy

BaseStructure
- Sku

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Sku(client: ShardClient, data?: BaseStructureData, isClone?: boolean): Sku

Overrides BaseStructure.constructor
- Defined in src/structures/store.ts:188
Parameters
- client: ShardClient
- Optional data: BaseStructureData
- Optional isClone: boolean
Returns Sku

Properties

Readonly _keys

_keys: BaseSet<string> = ...

accessType

accessType: number = 0

Optional application

application: Application

applicationId

applicationId: string = ''

Readonly client

client: ShardClient

Optional contentRating

contentRating: { descriptors: number[]; rating: number }

Type declaration

descriptors: number[]
rating: number

contentRatingAgency

contentRatingAgency: number = 0

dependentSkuId

dependentSkuId: null | string = null

Optional features

features: number[]

flags

flags: number = 0

Optional genres

genres: number[]

id

id: string = ''

legalNotice

legalNotice: string = ''

Optional locales

locales: string[]

Optional manifestLabels

manifestLabels: null | any[]

name

name: string = ''

Optional premium

premium: null

Optional price

price: { amount: number; currency: string }

Type declaration

amount: number
currency: string

Optional releaseDate

releaseDate: null | string

showAgeGate

showAgeGate: boolean = false

slug

slug: string = ''

Optional systemRequirements

systemRequirements: {}

Type declaration

[key: string]: { minimum: any; recommended: any }
- minimum: any
- recommended: any

type

type: SkuTypes = ...

Accessors

isClone

get isClone(): boolean

- Defined in src/structures/basestructure.ts:317
Returns boolean

shardId

get shardId(): number

- Defined in src/structures/basestructure.ts:321
Returns number

url

get url(): string

- Defined in src/structures/store.ts:199
Returns string

Methods

[custom]

[custom](): object

Inherited from BaseStructure.[custom]
- Defined in src/structures/basestructure.ts:282
Returns object

_getFromSnake

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake
- Defined in src/structures/basestructure.ts:33
Parameters
- key: string
Returns any

_setFromSnake

_setFromSnake(key: string, value: any): any

Inherited from BaseStructure._setFromSnake
- Defined in src/structures/basestructure.ts:37
Parameters
- key: string
- value: any
Returns any

clone

clone(): Sku

Inherited from BaseStructure.clone
- Defined in src/structures/basestructure.ts:325
Returns Sku

difference

difference(key: string, value: any): [boolean, any]

Inherited from BaseStructure.difference
- Defined in src/structures/basestructure.ts:41
Parameters
- key: string
- value: any
Returns [boolean, any]

differences

differences(data?: BaseStructureData): null | object

Inherited from BaseStructure.differences
- Defined in src/structures/basestructure.ts:67
Parameters
- Optional data: BaseStructureData
Returns null | object

differencesBetween

differencesBetween(structure: Structure): null | object

Inherited from BaseStructure.differencesBetween
- Defined in src/structures/basestructure.ts:86
Parameters
- structure: Structure
Returns null | object

hasDifference

hasDifference(key: string, value: any): boolean

Inherited from BaseStructure.hasDifference
- Defined in src/structures/basestructure.ts:107
Parameters
- key: string
- value: any
Returns boolean

hasDifferences

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences
- Defined in src/structures/basestructure.ts:195
Parameters
- Optional data: BaseStructureData
Returns boolean

hasDifferencesBetween

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween
- Defined in src/structures/basestructure.ts:210
Parameters
- structure: Structure
Returns boolean

merge

merge(data?: BaseStructureData): void

Inherited from BaseStructure.merge
- Defined in src/structures/basestructure.ts:225
Parameters
- Optional data: BaseStructureData
Returns void

mergeValue

mergeValue(key: string, value: any): void

Overrides BaseStructure.mergeValue
- Defined in src/structures/store.ts:203
Parameters
- key: string
- value: any
Returns void

toJSON

toJSON(): object

Inherited from BaseStructure.toJSON
- Defined in src/structures/basestructure.ts:259
Returns object

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: ShardClient

Optional data: BaseStructureData

Optional isClone: boolean

Returns Sku

Properties

Readonly _keys

accessType

Optional application

applicationId

Readonly client

Optional contentRating

Type declaration

descriptors: number[]

rating: number

contentRatingAgency

dependentSkuId

Optional features

flags

Optional genres

id

legalNotice

Optional locales

Optional manifestLabels

name

Optional premium

Optional price

Type declaration

amount: number

currency: string

Optional releaseDate

showAgeGate

slug

Optional systemRequirements

Type declaration

[key: string]: { minimum: any; recommended: any }

minimum: any

recommended: any

type

Accessors

isClone

Returns boolean

shardId

Returns number

url

Returns string

Methods

[custom]

Returns object

_getFromSnake

Parameters

key: string

Returns any

_setFromSnake

Parameters

key: string

value: any

Returns any

clone

Returns Sku

difference

Parameters

key: string

value: any

Returns [boolean, any]

differences

Parameters

Optional data: BaseStructureData

Returns null | object

differencesBetween

Parameters

structure: Structure