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 full)

NamespacedValue<S, U>
- ServerControlledNamespacedValue

Index

Constructors

constructor

new ServerControlledNamespacedValue<S, U>(stable, unstable): 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:26
new ServerControlledNamespacedValue<S, U>(stable, unstable?): ServerControlledNamespacedValue<S, U>
Type Parameters
- S extends string
- U extends string
Parameters
- stable: S
- Optionalunstable: U
Returns ServerControlledNamespacedValue<S, U>
Inherited from NamespacedValue.constructor
- Defined in src/NamespacedValue.ts:27
new ServerControlledNamespacedValue<S, U>(stable, unstable): ServerControlledNamespacedValue<S, U>
Type Parameters
- S extends string
- U extends string
Parameters
- stable: undefined | null
- unstable: U
Returns ServerControlledNamespacedValue<S, U>
Inherited from NamespacedValue.constructor
- Defined in src/NamespacedValue.ts:28

Properties

`Optional` `Readonly`stable

stable?: null | S

`Optional` `Readonly`unstable

unstable?: U

Accessors

altName

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

name

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

names

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

Methods

findIn

findIn<T>(obj): Optional<T>
Type Parameters
- T
Parameters
- obj: any
Returns Optional<T>
Inherited from NamespacedValue.findIn
- Defined in src/NamespacedValue.ts:65

includedIn

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

matches

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

setPreferUnstable

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

Class ServerControlledNamespacedValue<S, U>

Type Parameters

Hierarchy (view full)

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

Optional Readonlystable

Optional Readonlyunstable

Accessors

altName

Returns | undefined | null | S | U

name

Returns S | U

names

Returns (S | U)[]

Methods

findIn

Type Parameters

Parameters

Returns Optional<T>

includedIn

Parameters

Returns boolean

matches

Parameters

Returns boolean

setPreferUnstable

Parameters

Returns void

Settings

On This Page

`Optional` `Readonly`stable

`Optional` `Readonly`unstable

Returns
| undefined
| null
| S
| U