Directory

Directory interface for managing addresses

This is the public API contract for address directory functionality. It provides access to addresses, loading capabilities, and search functionality.

Extends

AddressProvider<Address> (see Address)

Properties

addresses

Address[]

Current snapshot of all addresses in the directory

addresses$

Observable<Address[]>

Observable stream of all addresses in the directory Emits a new array whenever addresses are added, removed, or updated

hasMore$

Observable<boolean>

Observable indicating whether more addresses can be loaded from the server

loading

boolean

Whether the directory is currently loading.

loading$

Observable<boolean>

Observable indicating the current loading state Emits true when loading, false when idle

Methods

findAddressIdByURI()

1 findAddressIdByURI(uri): Promise<string | undefined>

Find an address ID by searching for a name

Parameters

uri

stringRequired

The address name to search for

Returns

Promise<string | undefined>

Promise resolving to the address ID, or undefined if not found

get()

1 get(addressId): Address | undefined

Get a specific address by ID

Parameters

addressId

stringRequired

The address ID to retrieve

Returns

Address | undefined

The address instance, or undefined if not found

get$()

1 get$(id): Observable<Address> | undefined

Get an observable stream for a specific address by ID

Parameters

id

stringRequired

The address ID to retrieve

Returns

Observable<Address> | undefined

Observable of the address, or undefined if not found

Inherited from

AddressProvider.get$

loadMore()

1 loadMore(): void

Load more addresses from the server Only loads if hasMore is true

Returns

void