FiberId.ts overview
Since v2.0.0
Exports Grouped by Category
constructors
combine
Combine two FiberIds.
Signature
declare const combine: { (that: FiberId): (self: FiberId) => FiberId; (self: FiberId, that: FiberId): FiberId }
Since v2.0.0
combineAll
Combines a set of FiberIds into a single FiberId.
Signature
declare const combineAll: (fiberIds: HashSet.HashSet<FiberId>) => FiberId
Since v2.0.0
composite
Signature
declare const composite: (left: FiberId, right: FiberId) => Composite
Since v2.0.0
make
Creates a new FiberId.
Signature
declare const make: (id: number, startTimeSeconds: number) => FiberId
Since v2.0.0
none
Signature
declare const none: None
Since v2.0.0
runtime
Signature
declare const runtime: (id: number, startTimeMillis: number) => Runtime
Since v2.0.0
destructors
ids
Get the set of identifiers for this FiberId.
Signature
declare const ids: (self: FiberId) => HashSet.HashSet<number>
Since v2.0.0
threadName
Creates a string representing the name of the current thread of execution represented by the specified FiberId.
Signature
declare const threadName: (self: FiberId) => string
Since v2.0.0
toOption
Convert a FiberId into an Option<FiberId>.
Signature
declare const toOption: (self: FiberId) => Option.Option<FiberId>
Since v2.0.0
toSet
Convert a FiberId into a HashSet<FiberId>.
Signature
declare const toSet: (self: FiberId) => HashSet.HashSet<Runtime>
Since v2.0.0
models
Composite (interface)
Signature
export interface Composite extends Equal.Equal, Inspectable {
readonly [FiberIdTypeId]: FiberIdTypeId
readonly _tag: "Composite"
readonly left: FiberId
readonly right: FiberId
}
Since v2.0.0
FiberId (type alias)
Signature
type FiberId = Single | Composite
Since v2.0.0
None (interface)
Signature
export interface None extends Equal.Equal, Inspectable {
readonly [FiberIdTypeId]: FiberIdTypeId
readonly _tag: "None"
readonly id: -1
readonly startTimeMillis: -1
}
Since v2.0.0
Runtime (interface)
Signature
export interface Runtime extends Equal.Equal, Inspectable {
readonly [FiberIdTypeId]: FiberIdTypeId
readonly _tag: "Runtime"
readonly id: number
readonly startTimeMillis: number
}
Since v2.0.0
Single (type alias)
Signature
type Single = None | Runtime
Since v2.0.0
refinements
isComposite
Returns true if the FiberId is a Composite, false otherwise.
Signature
declare const isComposite: (self: FiberId) => self is Composite
Since v2.0.0
isFiberId
Returns true if the specified unknown value is a FiberId, false otherwise.
Signature
declare const isFiberId: (self: unknown) => self is FiberId
Since v2.0.0
isNone
Returns true if the FiberId is a None, false otherwise.
Signature
declare const isNone: (self: FiberId) => self is None
Since v2.0.0
isRuntime
Returns true if the FiberId is a Runtime, false otherwise.
Signature
declare const isRuntime: (self: FiberId) => self is Runtime
Since v2.0.0
symbols
FiberIdTypeId
Signature
declare const FiberIdTypeId: unique symbol
Since v2.0.0
FiberIdTypeId (type alias)
Signature
type FiberIdTypeId = typeof FiberIdTypeId
Since v2.0.0
unsafe
unsafeMake
Unsafely creates a new FiberId.
Signature
declare const unsafeMake: (_: void) => Runtime
Since v2.0.0
utils
getOrElse
Returns this FiberId if it is not None, otherwise returns that FiberId.
Signature
declare const getOrElse: { (that: FiberId): (self: FiberId) => FiberId; (self: FiberId, that: FiberId): FiberId }
Since v2.0.0