@exodus/atoms

Version: 0.0.0

Interfaces

Atom

Atom

interface

Methods

get

get(): Promise

Returns:

Promise

observe

observe(listener: Listener): Unsubscribe

Parameters:

listener: Listener

Returns:

Unsubscribe

reset

reset(): Promise

Returns:

Promise

set

set(value: T): Promise

Parameters:

value: T

Returns:

Promise

set(setter: Setter): Promise

Parameters:

setter: Setter

Returns:

Promise

EventEmitter

interface

Methods

on(event: string, listener: Listener): void

Parameters:

event: string

listener: Listener

Returns:

void

removeListener

removeListener(event: string, listener: Listener): void

Parameters:

event: string

listener: Listener

Returns:

void

Keystore

interface

Methods

deleteSecret

deleteSecret(key: string, options?: object): Promise

Parameters:

key: string

options (optional): object

Returns:

Promise

getSecret

getSecret(key: string, options?: object): Promise

Parameters:

key: string

options (optional): object

Returns:

Promise

setSecret

setSecret(key: string, value: KeystoreValue, options?: object): Promise

Parameters:

key: string

value: KeystoreValue

options (optional): object

Returns:

Promise

Port

interface

Methods

emit

emit(event: string, value: T): void

Parameters:

event: string

value: T

Returns:

void

AnyAtom

type

AtomValue

type

KeystoreValue

type

Listener

type

Logger

type

ReadonlyAtom

type

ResettableListener

type

SetAtomValue

type

Setter

type

Unsubscribe

type

combine

variable

Type

const combine: (atoms: U) => ReadonlyAtom

Signature

__type(atoms: U): ReadonlyAtom

Parameters:

atoms: U

Returns:

ReadonlyAtom

compute

variable

Type

const compute: ({ atom, selector }: Params) => ReadonlyAtom

Signature

__type({ atom, selector }: Params): ReadonlyAtom

Parameters:

{ atom, selector }: Params

Returns:

ReadonlyAtom

createAtomMock

variable

Type

const createAtomMock: (options: Params) => Atom

Signature

__type(options?: Params): Atom

Parameters:

options (optional): Params

Returns:

Atom

createAtomObserver

variable

Type

const createAtomObserver: ({ port, atom, event, immediateRegister }: Params) => { ... }

Signature

__type({ port, atom, event, immediateRegister }: Params): any

Parameters:

{ port, atom, event, immediateRegister }: Params

Returns:

any

Properties

any

start

any

unregister

any

createKeystoreAtom

variable

Type

const createKeystoreAtom: ({ keystore, config: { key, defaultValue, isSoleWriter, getOpts, setOpts, deleteOpts, }, }: Params) => Atom

Signature

__type({ keystore, config: { key, defaultValue, isSoleWriter, getOpts, setOpts, deleteOpts, }, }: Params): Atom

Parameters:

{ keystore, config: { key, defaultValue, isSoleWriter, getOpts, setOpts, deleteOpts, }, }: Params

Returns:

Atom

createSequencedKeystoreAtom

variable

Type

const createSequencedKeystoreAtom: ({ keystore, config: { key, separator, defaultValue, isSoleWriter, getOpts, setOpts, deleteOpts, }, }: Params) => Atom

Signature

__type({ keystore, config: { key, separator, defaultValue, isSoleWriter, getOpts, setOpts, deleteOpts, }, }: Params): Atom

Parameters:

{ keystore, config: { key, separator, defaultValue, isSoleWriter, getOpts, setOpts, deleteOpts, }, }: Params

Returns:

Atom

createSimpleObserver

variable

Type

const createSimpleObserver: ({ enable }: { ... }) => { ... }

Signature

__type({ enable }?: any): any

Parameters:

{ enable } (optional): any

Returns:

any

Properties

listeners

Listener[]

notify

any

observe

any

dedupe

variable

Type

const dedupe: (atom: Atom) => Atom

Signature

__type(atom: Atom): Atom

Parameters:

atom: Atom

Returns:

Atom

difference

variable

Type

const difference: (atom: Atom, options: O) => any

Signature

__type(atom: Atom, options?: O): any

Parameters:

atom: Atom

options (optional): O

Returns:

any

enforceObservableRules

variable

Type

const enforceObservableRules: ({ defaultValue, makeGetNonConcurrent, getInitialized, ...atom }: Params) => Atom

Signature

__type({ defaultValue, makeGetNonConcurrent, getInitialized, ...atom }: Params): Atom

Parameters:

{ defaultValue, makeGetNonConcurrent, getInitialized, ...atom }: Params

Returns:

Atom

fromEventEmitter

variable

Type

const fromEventEmitter: ({ emitter, event, get, set, defaultValue, getInitialized, }: Params) => Atom

Signature

__type({ emitter, event, get, set, defaultValue, getInitialized, }: Params): Atom

Parameters:

{ emitter, event, get, set, defaultValue, getInitialized, }: Params

Returns:

Atom

mergeWithValue

variable

Type

const mergeWithValue: ({ atom, value }: Params) => Atom

Signature

__type({ atom, value }: Params): Atom

Parameters:

{ atom, value }: Params

Returns:

Atom

optimisticNotifier

variable

Type

const optimisticNotifier: (atom: Atom) => Atom

Signature

__type(atom: Atom): Atom

Parameters:

atom: Atom

Returns:

Atom

readOnly

variable

Type

const readOnly: (atom: Atom) => ReadonlyAtom

Signature

__type(atom: Atom): ReadonlyAtom

Parameters:

atom: Atom

Returns:

ReadonlyAtom

swallowObserverErrors

variable

Type

const swallowObserverErrors: ({ atom, logger }: Params) => { ... }

Signature

__type({ atom, logger }: Params): any

Parameters:

{ atom, logger }: Params

Returns:

any

Properties

observe

any

timeoutObservers

variable

Type

const timeoutObservers: ({ atom, timeout }: Params) => Atom

Signature

__type({ atom, timeout }: Params): Atom

Parameters:

{ atom, timeout }: Params

Returns:

Atom

waitUntil

variable

Type

const waitUntil: ({ atom, predicate, rejectAfter }: Params) => UnobservablePromise

Signature

__type({ atom, predicate, rejectAfter }: Params): UnobservablePromise

Parameters:

{ atom, predicate, rejectAfter }: Params

Returns:

UnobservablePromise

warnOnSameValueSet

variable

Type

const warnOnSameValueSet: ({ atom, isEqual, logger }: Params) => Atom

Signature

__type({ atom, isEqual, logger }: Params): Atom

Parameters:

{ atom, isEqual, logger }: Params

Returns:

Atom

withSerialization

variable

Type

const withSerialization: ({ atom, serialize: customSerialize, deserialize: customDeserialize, pure, }: Params) => Atom

Signature

__type({ atom, serialize: customSerialize, deserialize: customDeserialize, pure, }: Params): Atom

Parameters:

{ atom, serialize: customSerialize, deserialize: customDeserialize, pure, }: Params

Returns:

Atom

withStorageCache

variable

Type

const withStorageCache: (params: Params) => Atom

Signature

__type(params: Params): Atom

Parameters:

params: Params

Returns:

Atom

blockUntil

function

Signature

blockUntil(__namedParameters: Params): any

Parameters:

__namedParameters: Params

Returns:

any

createStorageAtomFactory

function

Signature

createStorageAtomFactory(params: any): any

Parameters:

params: any

Returns:

any

createStorageAtomFactory(params: any): any

Parameters:

params: any

Returns:

any

filter

function

Signature

filter(atom: A, predicate: P): SetAtomValue

Parameters:

atom: A

predicate: P

Returns:

SetAtomValue

Atom

interface

Methods

get

get(): Promise

Returns:

Promise

observe

observe(listener: Listener): Unsubscribe

Parameters:

listener: Listener

Returns:

Unsubscribe

reset

reset(): Promise

Returns:

Promise

set

set(value: T): Promise

Parameters:

value: T

Returns:

Promise

set(setter: Setter): Promise

Parameters:

setter: Setter

Returns:

Promise

EventEmitter

interface

Methods

on(event: string, listener: Listener): void

Parameters:

event: string

listener: Listener

Returns:

void

removeListener

removeListener(event: string, listener: Listener): void

Parameters:

event: string

listener: Listener

Returns:

void

Keystore

interface

Methods

deleteSecret

deleteSecret(key: string, options?: object): Promise

Parameters:

key: string

options (optional): object

Returns:

Promise

getSecret

getSecret(key: string, options?: object): Promise

Parameters:

key: string

options (optional): object

Returns:

Promise

setSecret

setSecret(key: string, value: KeystoreValue, options?: object): Promise

Parameters:

key: string

value: KeystoreValue

options (optional): object

Returns:

Promise

Port

interface

Methods

emit

emit(event: string, value: T): void

Parameters:

event: string

value: T

Returns:

void

AnyAtom

type

AtomValue

type

KeystoreValue

type

Listener

type

Logger

type

ReadonlyAtom

type

ResettableListener

type

SetAtomValue

type

Setter

type

Unsubscribe

type

blockUntil

function

Signature

blockUntil(__namedParameters: Params): any

Parameters:

__namedParameters: Params

Returns:

any

combine

function

Signature

combine(atoms: U): ReadonlyAtom

Parameters:

atoms: U

Returns:

ReadonlyAtom

compute

function

Signature

compute(__namedParameters: Params): ReadonlyAtom

Parameters:

__namedParameters: Params

Returns:

ReadonlyAtom

createAtomMock

function

Signature

createAtomMock(options: Params): Atom

Parameters:

options: Params

Returns:

Atom

createAtomObserver

function

Signature

createAtomObserver(__namedParameters: Params): any

Parameters:

__namedParameters: Params

Returns:

any

createKeystoreAtom

function

Signature

createKeystoreAtom(__namedParameters: Params): Atom

Parameters:

__namedParameters: Params

Returns:

Atom

createSequencedKeystoreAtom

function

Signature

createSequencedKeystoreAtom(__namedParameters: Params): Atom

Parameters:

__namedParameters: Params

Returns:

Atom

createSimpleObserver

function

Signature

createSimpleObserver(__namedParameters: any): any

Parameters:

__namedParameters: any

Returns:

any

createStorageAtomFactory

function

Signature

createStorageAtomFactory(params: any): any

Parameters:

params: any

Returns:

any

createStorageAtomFactory(params: any): any

Parameters:

params: any

Returns:

any

dedupe

function

Signature

dedupe(atom: Atom): Atom

Parameters:

atom: Atom

Returns:

Atom

difference

function

Signature

difference(atom: Atom, options?: O): any

Parameters:

atom: Atom

options (optional): O

Returns:

any

enforceObservableRules

function

Signature

enforceObservableRules(__namedParameters: Params): Atom

Parameters:

__namedParameters: Params

Returns:

Atom

filter

function

Signature

filter(atom: A, predicate: P): SetAtomValue

Parameters:

atom: A

predicate: P

Returns:

SetAtomValue

fromEventEmitter

function

Signature

fromEventEmitter(__namedParameters: Params): Atom

Parameters:

__namedParameters: Params

Returns:

Atom

mergeWithValue

function

Signature

mergeWithValue(__namedParameters: Params): Atom

Parameters:

__namedParameters: Params

Returns:

Atom

optimisticNotifier

function

Signature

optimisticNotifier(atom: Atom): Atom

Parameters:

atom: Atom

Returns:

Atom

readOnly

function

Signature

readOnly(atom: Atom): ReadonlyAtom

Parameters:

atom: Atom

Returns:

ReadonlyAtom

swallowObserverErrors

function

Signature

swallowObserverErrors(__namedParameters: Params): any

Parameters:

__namedParameters: Params

Returns:

any

timeoutObservers

function

Signature

timeoutObservers(__namedParameters: Params): Atom

Parameters:

__namedParameters: Params

Returns:

Atom

waitUntil

function

Signature

waitUntil(__namedParameters: Params): UnobservablePromise

Parameters:

__namedParameters: Params

Returns:

UnobservablePromise

warnOnSameValueSet

function

Signature

warnOnSameValueSet(__namedParameters: Params): Atom

Parameters:

__namedParameters: Params

Returns:

Atom

withSerialization

function

Signature

withSerialization(__namedParameters: Params): Atom

Parameters:

__namedParameters: Params

Returns:

Atom

withStorageCache

function

Signature

withStorageCache(params: Params): Atom

Caches the value of a given atom in a storage backed counterpart.

Parameters:

params: Params

Returns:

Atom

@exodus/errors @exodus/slip10

@exodus/atoms

Interfaces

Functions

Type Aliases

Variables

Atom

Methods

Returns:

Parameters:

Returns:

Returns:

Parameters:

Returns:

Parameters:

Returns:

EventEmitter

Methods

Parameters:

Returns:

Parameters:

Returns:

Keystore

Methods

Parameters:

Returns:

Parameters:

Returns:

Parameters:

Returns:

Port

Methods

Parameters:

Returns:

AnyAtom

AtomValue

KeystoreValue

Listener

Logger

ReadonlyAtom

ResettableListener

SetAtomValue

Setter

Unsubscribe

combine

Type

Signature

Parameters:

Returns:

compute

Type

Signature

Parameters:

Returns:

createAtomMock

Type

Signature

Parameters:

Returns:

createAtomObserver

Type

Signature

Parameters:

Returns:

Properties

createKeystoreAtom

Type

Signature

Parameters:

Returns:

createSequencedKeystoreAtom

Type

Signature

Parameters:

Returns:

createSimpleObserver

Type

Signature

Parameters:

Returns:

Properties