RuntimeFlagsPatch overview
Added in v2.0.0
Table of contents
constructors
disable
Creates a RuntimeFlagsPatch describing disabling the provided RuntimeFlag.
Signature
export declare const disable: (flag: RuntimeFlags.RuntimeFlag) => RuntimeFlagsPatch
Added in v2.0.0
empty
The empty RuntimeFlagsPatch.
Signature
export declare const empty: RuntimeFlagsPatch
Added in v2.0.0
enable
Creates a RuntimeFlagsPatch describing enabling the provided RuntimeFlag.
Signature
export declare const enable: (flag: RuntimeFlags.RuntimeFlag) => RuntimeFlagsPatch
Added in v2.0.0
make
Signature
export declare const make: (active: number, enabled: number) => RuntimeFlagsPatch
Added in v2.0.0
destructors
disabledSet
Returns a ReadonlySet<number> containing the RuntimeFlags described as disabled by the specified RuntimeFlagsPatch.
Signature
export declare const disabledSet: (self: RuntimeFlagsPatch) => ReadonlySet<RuntimeFlags.RuntimeFlag>
Added in v2.0.0
enabledSet
Returns a ReadonlySet<number> containing the RuntimeFlags described as enabled by the specified RuntimeFlagsPatch.
Signature
export declare const enabledSet: (self: RuntimeFlagsPatch) => ReadonlySet<RuntimeFlags.RuntimeFlag>
Added in v2.0.0
render
Renders the provided RuntimeFlagsPatch to a string.
Signature
export declare const render: (self: RuntimeFlagsPatch) => string
Added in v2.0.0
elements
includes
Returns true if the RuntimeFlagsPatch includes the specified RuntimeFlag, false otherwise.
Signature
export declare const includes: {
(flag: RuntimeFlagsPatch): (self: RuntimeFlagsPatch) => boolean
(self: RuntimeFlagsPatch, flag: RuntimeFlagsPatch): boolean
}
Added in v2.0.0
isActive
Returns true if the RuntimeFlagsPatch describes the specified RuntimeFlag as active.
Signature
export declare const isActive: {
(flag: RuntimeFlagsPatch): (self: RuntimeFlagsPatch) => boolean
(self: RuntimeFlagsPatch, flag: RuntimeFlagsPatch): boolean
}
Added in v2.0.0
isDisabled
Returns true if the RuntimeFlagsPatch describes the specified RuntimeFlag as disabled.
Signature
export declare const isDisabled: {
(flag: RuntimeFlags.RuntimeFlag): (self: RuntimeFlagsPatch) => boolean
(self: RuntimeFlagsPatch, flag: RuntimeFlags.RuntimeFlag): boolean
}
Added in v2.0.0
isEnabled
Returns true if the RuntimeFlagsPatch describes the specified RuntimeFlag as enabled.
Signature
export declare const isEnabled: {
(flag: RuntimeFlags.RuntimeFlag): (self: RuntimeFlagsPatch) => boolean
(self: RuntimeFlagsPatch, flag: RuntimeFlags.RuntimeFlag): boolean
}
Added in v2.0.0
getters
isEmpty
Returns true if the specified RuntimeFlagsPatch is empty.
Signature
export declare const isEmpty: (patch: RuntimeFlagsPatch) => boolean
Added in v2.0.0
models
RuntimeFlagsPatch (type alias)
Signature
export type RuntimeFlagsPatch = number & {
readonly RuntimeFlagsPatch: unique symbol
}
Added in v2.0.0
utils
andThen
Creates a RuntimeFlagsPatch describing the application of the self patch, followed by that patch.
Signature
export declare const andThen: {
(that: RuntimeFlagsPatch): (self: RuntimeFlagsPatch) => RuntimeFlagsPatch
(self: RuntimeFlagsPatch, that: RuntimeFlagsPatch): RuntimeFlagsPatch
}
Added in v2.0.0
both
Creates a RuntimeFlagsPatch describing application of both the self patch and that patch.
Signature
export declare const both: {
(that: RuntimeFlagsPatch): (self: RuntimeFlagsPatch) => RuntimeFlagsPatch
(self: RuntimeFlagsPatch, that: RuntimeFlagsPatch): RuntimeFlagsPatch
}
Added in v2.0.0
either
Creates a RuntimeFlagsPatch describing application of either the self patch or that patch.
Signature
export declare const either: {
(that: RuntimeFlagsPatch): (self: RuntimeFlagsPatch) => RuntimeFlagsPatch
(self: RuntimeFlagsPatch, that: RuntimeFlagsPatch): RuntimeFlagsPatch
}
Added in v2.0.0
exclude
Creates a RuntimeFlagsPatch which describes exclusion of the specified RuntimeFlag from the set of RuntimeFlags.
Signature
export declare const exclude: {
(flag: RuntimeFlags.RuntimeFlag): (self: RuntimeFlagsPatch) => RuntimeFlagsPatch
(self: RuntimeFlagsPatch, flag: RuntimeFlags.RuntimeFlag): RuntimeFlagsPatch
}
Added in v2.0.0
inverse
Creates a RuntimeFlagsPatch which describes the inverse of the patch specified by the provided RuntimeFlagsPatch.
Signature
export declare const inverse: (patch: RuntimeFlagsPatch) => RuntimeFlagsPatch
Added in v2.0.0