Skip to main content

Wallets

@iota/wallet-standard


@iota/wallet-standard / Wallets

Interface: Wallets

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@wallet-standard/app/lib/types/wallets.d.ts:28

API for getting, listening for, and registering "@wallet-standard/base".Wallet | Wallets.

Methods​

get()​

get(): readonly Wallet[]

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@wallet-standard/app/lib/types/wallets.d.ts:34

Get all Wallets that have been registered.

Returns​

readonly Wallet[]

Registered Wallets.


on()​

on<E>(event, listener): () => void

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@wallet-standard/app/lib/types/wallets.d.ts:49

Add an event listener and subscribe to events for Wallets that are registered and unregistered.

Type Parameters​

E​

E extends keyof WalletsEventsListeners

Parameters​

event​

E

Event type to listen for. `register` and `unregister` are the only event types.

listener​

WalletsEventsListeners[E]

Function that will be called when an event of the type is emitted.

Returns​

off function which may be called to remove the event listener and unsubscribe from events.

As with all event listeners, be careful to avoid memory leaks.

() => void


register()​

register(...wallets): () => void

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@wallet-standard/app/lib/types/wallets.d.ts:62

Register Wallets. This can be used to programmatically wrap non-standard wallets as Standard Wallets.

Apps generally do not need to, and should not, call this.

Parameters​

wallets​

...Wallet[]

Wallets to register.

Returns​

unregister function which may be called to programmatically unregister the registered Wallets.

Apps generally do not need to, and should not, call this.

() => void