RuntimeFlagsPatch.ts overview

Since v2.0.0

Exports Grouped by Category

• constructors
  • disable
  • empty
  • enable
  • make
• destructors
  • disabledSet
  • enabledSet
  • render
• elements
  • includes
  • isActive
  • isDisabled
  • isEnabled
• getters
  • isEmpty
• models
  • RuntimeFlagsPatch (type alias)
• utils
  • andThen
  • both
  • either
  • exclude
  • inverse

constructors

disable

Creates a RuntimeFlagsPatch describing disabling the provided RuntimeFlag.

Signature

declare const disable: (flag: RuntimeFlags.RuntimeFlag) => RuntimeFlagsPatch

Source

Since v2.0.0

empty

The empty RuntimeFlagsPatch.

Signature

declare const empty: RuntimeFlagsPatch

Source

Since v2.0.0

enable

Creates a RuntimeFlagsPatch describing enabling the provided RuntimeFlag.

Signature

declare const enable: (flag: RuntimeFlags.RuntimeFlag) => RuntimeFlagsPatch

Source

Since v2.0.0

make

Signature

declare const make: (active: number, enabled: number) => RuntimeFlagsPatch

Source

Since v2.0.0

destructors

disabledSet

Returns a ReadonlySet<number> containing the RuntimeFlags described as disabled by the specified RuntimeFlagsPatch.

Signature

declare const disabledSet: (self: RuntimeFlagsPatch) => ReadonlySet<RuntimeFlags.RuntimeFlag>

Source

Since v2.0.0

enabledSet

Returns a ReadonlySet<number> containing the RuntimeFlags described as enabled by the specified RuntimeFlagsPatch.

Signature

declare const enabledSet: (self: RuntimeFlagsPatch) => ReadonlySet<RuntimeFlags.RuntimeFlag>

Source

Since v2.0.0

render

Renders the provided RuntimeFlagsPatch to a string.

Signature

declare const render: (self: RuntimeFlagsPatch) => string

Source

Since v2.0.0

elements

includes

Returns true if the RuntimeFlagsPatch includes the specified RuntimeFlag, false otherwise.

Signature

declare const includes: {
  (flag: RuntimeFlagsPatch): (self: RuntimeFlagsPatch) => boolean
  (self: RuntimeFlagsPatch, flag: RuntimeFlagsPatch): boolean
}

Source

Since v2.0.0

isActive

Returns true if the RuntimeFlagsPatch describes the specified RuntimeFlag as active.

Signature

declare const isActive: {
  (flag: RuntimeFlagsPatch): (self: RuntimeFlagsPatch) => boolean
  (self: RuntimeFlagsPatch, flag: RuntimeFlagsPatch): boolean
}

Source

Since v2.0.0

isDisabled

Returns true if the RuntimeFlagsPatch describes the specified RuntimeFlag as disabled.

Signature

declare const isDisabled: {
  (flag: RuntimeFlags.RuntimeFlag): (self: RuntimeFlagsPatch) => boolean
  (self: RuntimeFlagsPatch, flag: RuntimeFlags.RuntimeFlag): boolean
}

Source

Since v2.0.0

isEnabled

Returns true if the RuntimeFlagsPatch describes the specified RuntimeFlag as enabled.

Signature

declare const isEnabled: {
  (flag: RuntimeFlags.RuntimeFlag): (self: RuntimeFlagsPatch) => boolean
  (self: RuntimeFlagsPatch, flag: RuntimeFlags.RuntimeFlag): boolean
}

Source

Since v2.0.0

getters

isEmpty

Returns true if the specified RuntimeFlagsPatch is empty.

Signature

declare const isEmpty: (patch: RuntimeFlagsPatch) => boolean

Source

Since v2.0.0

models

RuntimeFlagsPatch (type alias)

Signature

type RuntimeFlagsPatch = number & {
  readonly RuntimeFlagsPatch: unique symbol
}

Source

Since v2.0.0

utils

andThen

Creates a RuntimeFlagsPatch describing the application of the self patch, followed by that patch.

Signature

declare const andThen: {
  (that: RuntimeFlagsPatch): (self: RuntimeFlagsPatch) => RuntimeFlagsPatch
  (self: RuntimeFlagsPatch, that: RuntimeFlagsPatch): RuntimeFlagsPatch
}

Source

Since v2.0.0

both

Creates a RuntimeFlagsPatch describing application of both the self patch and that patch.

Signature

declare const both: {
  (that: RuntimeFlagsPatch): (self: RuntimeFlagsPatch) => RuntimeFlagsPatch
  (self: RuntimeFlagsPatch, that: RuntimeFlagsPatch): RuntimeFlagsPatch
}

Source

Since v2.0.0

either

Creates a RuntimeFlagsPatch describing application of either the self patch or that patch.

Signature

declare const either: {
  (that: RuntimeFlagsPatch): (self: RuntimeFlagsPatch) => RuntimeFlagsPatch
  (self: RuntimeFlagsPatch, that: RuntimeFlagsPatch): RuntimeFlagsPatch
}

Source

Since v2.0.0

exclude

Creates a RuntimeFlagsPatch which describes exclusion of the specified RuntimeFlag from the set of RuntimeFlags.

Signature

declare const exclude: {
  (flag: RuntimeFlags.RuntimeFlag): (self: RuntimeFlagsPatch) => RuntimeFlagsPatch
  (self: RuntimeFlagsPatch, flag: RuntimeFlags.RuntimeFlag): RuntimeFlagsPatch
}

Source

Since v2.0.0

inverse

Creates a RuntimeFlagsPatch which describes the inverse of the patch specified by the provided RuntimeFlagsPatch.

Signature

declare const inverse: (patch: RuntimeFlagsPatch) => RuntimeFlagsPatch

Source

Since v2.0.0