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

FiberStatus.ts overview

Since v2.0.0

Exports Grouped by Category

constructors

done

Signature

declare const done: FiberStatus

Source

Since v2.0.0

running

Signature

declare const running: (runtimeFlags: RuntimeFlags.RuntimeFlags) => FiberStatus

Source

Since v2.0.0

suspended

Signature

declare const suspended: (runtimeFlags: RuntimeFlags.RuntimeFlags, blockingOn: FiberId.FiberId) => FiberStatus

Source

Since v2.0.0

models

Done (interface)

Signature

export interface Done extends Equal.Equal {
  readonly _tag: "Done"
  readonly [FiberStatusTypeId]: FiberStatusTypeId
}

Source

Since v2.0.0

FiberStatus (type alias)

Signature

type FiberStatus = Done | Running | Suspended

Source

Since v2.0.0

Running (interface)

Signature

export interface Running extends Equal.Equal {
  readonly _tag: "Running"
  readonly [FiberStatusTypeId]: FiberStatusTypeId
  readonly runtimeFlags: RuntimeFlags.RuntimeFlags
}

Source

Since v2.0.0

Suspended (interface)

Signature

export interface Suspended extends Equal.Equal {
  readonly _tag: "Suspended"
  readonly [FiberStatusTypeId]: FiberStatusTypeId
  readonly runtimeFlags: RuntimeFlags.RuntimeFlags
  readonly blockingOn: FiberId.FiberId
}

Source

Since v2.0.0

refinements

isDone

Returns true if the specified FiberStatus is Done, false otherwise.

Signature

declare const isDone: (self: FiberStatus) => self is Done

Source

Since v2.0.0

isFiberStatus

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

Signature

declare const isFiberStatus: (u: unknown) => u is FiberStatus

Source

Since v2.0.0

isRunning

Returns true if the specified FiberStatus is Running, false otherwise.

Signature

declare const isRunning: (self: FiberStatus) => self is Running

Source

Since v2.0.0

isSuspended

Returns true if the specified FiberStatus is Suspended, false otherwise.

Signature

declare const isSuspended: (self: FiberStatus) => self is Suspended

Source

Since v2.0.0

symbols

FiberStatusTypeId

Signature

declare const FiberStatusTypeId: unique symbol

Source

Since v2.0.0

FiberStatusTypeId (type alias)

Signature

type FiberStatusTypeId = typeof FiberStatusTypeId

Source

Since v2.0.0