Skip to content

effect

const effect: object

Defined in: src/PrivateState.ts:514

Raw Effect APIs for advanced users.

Type Declaration

clear()

clear: (provider) => Effect<void, PrivateStateError> = clearEffect

Parameters

provider

PrivateStateProviderData

Returns

Effect<void, PrivateStateError>

clearSigningKeys()

clearSigningKeys: (provider) => Effect<void, PrivateStateError> = clearSigningKeysEffect

Parameters

provider

PrivateStateProviderData

Returns

Effect<void, PrivateStateError>

get()

get: (provider, privateStateId) => Effect<unknown, PrivateStateError> = getEffect

Parameters

provider

PrivateStateProviderData

privateStateId

string

Returns

Effect<unknown, PrivateStateError>

getSigningKey()

getSigningKey: (provider, address) => Effect<string | null, PrivateStateError> = getSigningKeyEffect

Parameters

provider

PrivateStateProviderData

address

string

Returns

Effect<string | null, PrivateStateError>

remove()

remove: (provider, privateStateId) => Effect<void, PrivateStateError> = removeEffect

Parameters

provider

PrivateStateProviderData

privateStateId

string

Returns

Effect<void, PrivateStateError>

removeSigningKey()

removeSigningKey: (provider, address) => Effect<void, PrivateStateError> = removeSigningKeyEffect

Parameters

provider

PrivateStateProviderData

address

string

Returns

Effect<void, PrivateStateError>

set()

set: (provider, privateStateId, state) => Effect<void, PrivateStateError> = setEffect

Parameters

provider

PrivateStateProviderData

privateStateId

string

state

unknown

Returns

Effect<void, PrivateStateError>

setSigningKey()

setSigningKey: (provider, address, signingKey) => Effect<void, PrivateStateError> = setSigningKeyEffect

Parameters

provider

PrivateStateProviderData

address

string

signingKey

string

Returns

Effect<void, PrivateStateError>

Since

0.2.0