Skip to main content Link Search Menu Expand Document (external link)

FiberId overview

Added in v2.0.0


Table of contents


constructors

combine

Combine two FiberIds.

Signature

export declare const combine: { (that: FiberId): (self: FiberId) => FiberId; (self: FiberId, that: FiberId): FiberId }

Added in v2.0.0

combineAll

Combines a set of FiberIds into a single FiberId.

Signature

export declare const combineAll: (fiberIds: HashSet.HashSet<FiberId>) => FiberId

Added in v2.0.0

composite

Signature

export declare const composite: (left: FiberId, right: FiberId) => Composite

Added in v2.0.0

make

Creates a new FiberId.

Signature

export declare const make: (id: number, startTimeSeconds: number) => FiberId

Added in v2.0.0

none

Signature

export declare const none: None

Added in v2.0.0

runtime

Signature

export declare const runtime: (id: number, startTimeMillis: number) => Runtime

Added in v2.0.0

destructors

ids

Get the set of identifiers for this FiberId.

Signature

export declare const ids: (self: FiberId) => HashSet.HashSet<number>

Added in v2.0.0

threadName

Creates a string representing the name of the current thread of execution represented by the specified FiberId.

Signature

export declare const threadName: (self: FiberId) => string

Added in v2.0.0

toOption

Convert a FiberId into an Option<FiberId>.

Signature

export declare const toOption: (self: FiberId) => Option.Option<FiberId>

Added in v2.0.0

toSet

Convert a FiberId into a HashSet<FiberId>.

Signature

export declare const toSet: (self: FiberId) => HashSet.HashSet<Runtime>

Added in 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
}

Added in v2.0.0

FiberId (type alias)

Signature

export type FiberId = Single | Composite

Added in 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
}

Added in 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
}

Added in v2.0.0

Single (type alias)

Signature

export type Single = None | Runtime

Added in v2.0.0

refinements

isComposite

Returns true if the FiberId is a Composite, false otherwise.

Signature

export declare const isComposite: (self: FiberId) => self is Composite

Added in v2.0.0

isFiberId

Returns true if the specified unknown value is a FiberId, false otherwise.

Signature

export declare const isFiberId: (self: unknown) => self is FiberId

Added in v2.0.0

isNone

Returns true if the FiberId is a None, false otherwise.

Signature

export declare const isNone: (self: FiberId) => self is None

Added in v2.0.0

isRuntime

Returns true if the FiberId is a Runtime, false otherwise.

Signature

export declare const isRuntime: (self: FiberId) => self is Runtime

Added in v2.0.0

symbols

FiberIdTypeId

Signature

export declare const FiberIdTypeId: typeof FiberIdTypeId

Added in v2.0.0

FiberIdTypeId (type alias)

Signature

export type FiberIdTypeId = typeof FiberIdTypeId

Added in v2.0.0

unsafe

unsafeMake

Unsafely creates a new FiberId.

Signature

export declare const unsafeMake: (_: void) => Runtime

Added in v2.0.0

utils

getOrElse

Returns this FiberId if it is not None, otherwise returns that FiberId.

Signature

export declare const getOrElse: { (that: FiberId): (self: FiberId) => FiberId; (self: FiberId, that: FiberId): FiberId }

Added in v2.0.0