Skip to main content
requests.RequestCustodian

Constructors

constructor

• new RequestCustodian(records, hash?)

Parameters

Properties

records

• Readonly records: AtomicRecordStore

hash

• Readonly hash: CustodyHash = custodyHash

Methods

capture

▸ capture(id, value): Promise<void>

Parameters

Returns

Promise<void>

effect

▸ effect(id, event): Promise<string>

Parameters

Returns

Promise<string>

inspect

▸ inspect(id): Promise<CustodyRecord | null>

Parameters

Returns

Promise<CustodyRecord | null>

assertAdmissible

▸ assertAdmissible(identity): Promise<void> Fence preparation effects before an immutable envelope exists.

Parameters

Returns

Promise<void>

load

▸ load(id): Promise<Record<string, unknown> | null>

Parameters

Returns

Promise<Record<string, unknown> | null>

collect

▸ collect(frontier, options?): Promise<{ collected: number ; next_cursor: string | null }>

Parameters

Returns

Promise<{ collected: number ; next_cursor: string | null }>

page

▸ page(cursor?, limit?): Promise<{ items: string[] ; next_cursor: string | null }>

Parameters

Returns

Promise<{ items: string[] ; next_cursor: string | null }>

list

▸ list(): Promise<string[]>

Returns

Promise<string[]>

requestClose

▸ requestClose(id): Promise<void>

Parameters

Returns

Promise<void>

observeClose

▸ observeClose(id, receipt, options?): Promise<void>

Parameters

Returns

Promise<void>

isClosing

▸ isClosing(id): Promise<boolean>

Parameters

Returns

Promise<boolean>

compareExchange

▸ compareExchange(id, expected, event): Promise<void>

Parameters

Returns

Promise<void>

publish

▸ publish(id, expected, check): Promise<void>

Parameters

Returns

Promise<void>