Class ServerControlledNamespacedValue<S, U>

Represents a simple Matrix namespaced value. This will assume that if a stable prefix is provided that the stable prefix should be used when representing the identifier.

Type Parameters

S extends string
U extends string

Hierarchy (View Summary)

NamespacedValue<S, U>
- ServerControlledNamespacedValue

Index

Constructors

constructor

new ServerControlledNamespacedValue<S extends string, U extends string>(
stable: S,
unstable: U,
): ServerControlledNamespacedValue<S, U>
Type Parameters
- S extends string
- U extends string
Parameters
- stable: S
- unstable: U
Returns ServerControlledNamespacedValue<S, U>
Inherited from NamespacedValue.constructor
- Defined in src/NamespacedValue.ts:24
new ServerControlledNamespacedValue<S extends string, U extends string>(
stable: S,
unstable: U | null,
): ServerControlledNamespacedValue<S, U>
Type Parameters
- S extends string
- U extends string
Parameters
- stable: S
- unstable: U | null
Returns ServerControlledNamespacedValue<S, U>
Inherited from NamespacedValue.constructor
- Defined in src/NamespacedValue.ts:25
new ServerControlledNamespacedValue<S extends string, U extends string>(
stable: null,
unstable: U,
): ServerControlledNamespacedValue<S, U>
Type Parameters
- S extends string
- U extends string
Parameters
- stable: null
- unstable: U
Returns ServerControlledNamespacedValue<S, U>
Inherited from NamespacedValue.constructor
- Defined in src/NamespacedValue.ts:26

Properties

`Readonly`stable

stable: S | null

`Readonly`unstable

unstable: U | null

Accessors

altName

get altName(): S | U | null | undefined
Returns S | U | null | undefined
Inherited from NamespacedValue.altName
- Defined in src/NamespacedValue.ts:43

name

get name(): S | U
Returns S | U
Overrides NamespacedValue.name
- Defined in src/NamespacedValue.ts:93

names

get names(): (S | U)[]
Returns (S | U)[]
Inherited from NamespacedValue.names
- Defined in src/NamespacedValue.ts:50

Methods

findIn

findIn<V>(obj: Partial<Record<NonNullable<S | U>, V>>): V | undefined
Type Parameters
- V
Parameters
- obj: Partial<Record<NonNullable<S | U>, V>>
Returns V | undefined
Inherited from NamespacedValue.findIn
- Defined in src/NamespacedValue.ts:63

includedIn

includedIn(arr: any[]): boolean
Parameters
- arr: any[]
Returns boolean
Inherited from NamespacedValue.includedIn
- Defined in src/NamespacedValue.ts:74

matches

matches(val: string): boolean
Parameters
- val: string
Returns boolean
Inherited from NamespacedValue.matches
- Defined in src/NamespacedValue.ts:57

setPreferUnstable

setPreferUnstable(preferUnstable: boolean): void
Parameters
- preferUnstable: boolean
Returns void
- Defined in src/NamespacedValue.ts:89

Class ServerControlledNamespacedValue<S, U>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ServerControlledNamespacedValue<S, U>

Type Parameters

Parameters

Returns ServerControlledNamespacedValue<S, U>

Type Parameters

Parameters

Returns ServerControlledNamespacedValue<S, U>

Properties

Readonlystable

Readonlyunstable

Accessors

altName

Returns S | U | null | undefined

name

Returns S | U

names

Returns (S | U)[]

Methods

findIn

Type Parameters

Parameters

Returns V | undefined

includedIn

Parameters

Returns boolean

matches

Parameters

Returns boolean

setPreferUnstable

Parameters

Returns void

Settings

On This Page

`Readonly`stable

`Readonly`unstable