Methods
Static delay
- delay(ms: number, signal?: AbortSignal): Promise<void>
-
Parameters
-
ms: number
-
Optional signal: AbortSignal
Returns Promise<void>
Static expectAnchorStatus
- expectAnchorStatus(stream: Stream, status: AnchorStatus, timeout?: number): Promise<void>
-
Parameters
-
stream: Stream
-
status: AnchorStatus
-
timeout: number = 1000
Returns Promise<void>
Static isPinned
- isPinned(adminApi: AdminApi, streamId: StreamID): Promise<boolean>
-
Parameters
-
adminApi: AdminApi
-
streamId: StreamID
Returns Promise<boolean>
Static makeStreamState
- makeStreamState(): StreamState<StreamMetadata>
-
Returns StreamState<StreamMetadata>
Static randomCID
- randomCID(version?: 0 | 1, codec?: number, hasher?: number): CID<unknown, number, number, Version>
-
Parameters
-
version: 0 | 1 = 1
-
codec: number = 0x71
-
hasher: number = 0x12
Returns CID<unknown, number, number, Version>
Static randomStreamID
- randomStreamID(): StreamID
-
Returns StreamID
Static runningState
- runningState(state: StreamState<StreamMetadata>): RunningStateLike
-
Parameters
-
state: StreamState<StreamMetadata>
Returns RunningStateLike
Static waitFor
- waitFor<T>(observable: Observable<T>, predicate: ((value: T) => boolean), timeoutMs?: number): Promise<void>
-
Parameters
-
observable: Observable<T>
-
predicate: ((value: T) => boolean)
-
- (value: T): boolean
-
Returns boolean
-
timeoutMs: number = ...
Returns Promise<void>
Static waitForConditionOrTimeout
- waitForConditionOrTimeout(predicate: (() => Promise<boolean>), timeoutMs?: number, errMsgGenerator?: string | (() => string)): Promise<void>
-
Parameters
-
predicate: (() => Promise<boolean>)
-
- (): Promise<boolean>
-
Returns Promise<boolean>
-
timeoutMs: number = ...
-
Optional errMsgGenerator: string | (() => string)
Returns Promise<void>
Static waitForEvent
- waitForEvent(reconFeed: Observable<Events>, cid: CID<unknown, number, number, Version>, timeoutMs?: number): Promise<void>
-
Parameters
-
reconFeed: Observable<Events>
-
cid: CID<unknown, number, number, Version>
-
timeoutMs: number = ...
Returns Promise<void>
Static waitForState
- waitForState(stream: Stream, timeoutMs: number, predicate: ((state: StreamState<StreamMetadata>) => boolean), onFailure?: ((state: StreamState<StreamMetadata>) => void)): Promise<void>
-
Parameters
-
stream: Stream
-
timeoutMs: number
-
predicate: ((state: StreamState<StreamMetadata>) => boolean)
-
- (state: StreamState<StreamMetadata>): boolean
-
Parameters
-
state: StreamState<StreamMetadata>
Returns boolean
-
Optional onFailure: ((state: StreamState<StreamMetadata>) => void)
-
- (state: StreamState<StreamMetadata>): void
-
Parameters
-
state: StreamState<StreamMetadata>
Returns void
Returns Promise<void>
Given a stream, continuously waits for the streams anchor status to be changed to
status