Class BaseWebIdStore

A WebIdStore using a AccountLoginStorage to store the links. Needs to be initialized before it can be used.

Hierarchy

Initializer
- BaseWebIdStore

Implements

WebIdStore

Index

Constructors

constructor

new BaseWebIdStore(storage): BaseWebIdStore
Parameters
- storage: AccountLoginStorage<Record<string, never>>
Returns BaseWebIdStore
Overrides Initializer.constructor
- Defined in src/identity/interaction/webid/util/BaseWebIdStore.ts:27

Properties

`Private` initialized

initialized: boolean = false

`Private` `Readonly` logger

logger: Logger = ...

`Private` `Readonly` storage

storage: AccountLoginStorage<{
    webIdLink: {
        accountId: "id:account";
        webId: "string";
    };
}>

Type declaration

webIdLink: {
accountId: "id:account";
webId: "string";
}
- Readonly accountId: "id:account"
- Readonly webId: "string"

Methods

canHandle

canHandle(input): Promise<void>
Checks whether the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.
Parameters
- input: void
  
  Input that could potentially be handled.
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.
Inherited from Initializer.canHandle
- Defined in src/util/handlers/AsyncHandler.ts:18

create

create(webId, accountId): Promise<string>
Creates a new WebID link for the given WebID and account.
Parameters
- webId: string
  
  WebID to link.
- accountId: string
Returns Promise<string>
ID of the link.
Implementation of WebIdStore.create
- Defined in src/identity/interaction/webid/util/BaseWebIdStore.ts:64

delete

delete(linkId): Promise<void>
Deletes the link with the given ID
Parameters
- linkId: string
  
  ID of the link.
Returns Promise<void>
Implementation of WebIdStore.delete
- Defined in src/identity/interaction/webid/util/BaseWebIdStore.ts:77

findLinks

findLinks(accountId): Promise<{
id: string;
webId: string;
}[]>
Finds all links associated with the given account.
Parameters
- accountId: string
  
  ID of the account.
Returns Promise<{
id: string;
webId: string;
}[]>
Implementation of WebIdStore.findLinks
- Defined in src/identity/interaction/webid/util/BaseWebIdStore.ts:59

get

get(id): Promise<undefined | {
accountId: string;
webId: string;
}>
Finds the account and WebID of the link with the given ID.
Parameters
- id: string
Returns Promise<undefined | {
accountId: string;
webId: string;
}>
Implementation of WebIdStore.get
- Defined in src/identity/interaction/webid/util/BaseWebIdStore.ts:50

handle

handle(): Promise<void>
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

Returns Promise<void>
A promise resolving when handling is finished.
Overrides Initializer.handle
- Defined in src/identity/interaction/webid/util/BaseWebIdStore.ts:33

handleSafe

handleSafe(input): Promise<void>
Helper function that first runs canHandle followed by handle. Throws the error of canHandle if the data cannot be handled, or returns the result of handle otherwise.
Parameters
- input: void
  
  Input data that will be handled if it can be handled.
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.
Inherited from Initializer.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:41

isLinked

isLinked(webId, accountId): Promise<boolean>
Determines if a WebID is linked to an account.
Parameters
- webId: string
  
  WebID to check.
- accountId: string
  
  ID of the account.
Returns Promise<boolean>
Implementation of WebIdStore.isLinked
- Defined in src/identity/interaction/webid/util/BaseWebIdStore.ts:54

Class BaseWebIdStore

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

storage: AccountLoginStorage<Record<string, never>>

Returns BaseWebIdStore

Properties

Private initialized

Private Readonly logger

Private Readonly storage

Type declaration

webIdLink: { accountId: "id:account"; webId: "string"; }

Readonly accountId: "id:account"

Readonly webId: "string"

Methods

canHandle

Parameters

input: void

Returns Promise<void>

create

Parameters

webId: string

accountId: string

Returns Promise<string>

delete

Parameters

linkId: string

Returns Promise<void>

findLinks

Parameters

accountId: string

Returns Promise<{ id: string; webId: string; }[]>

get

Parameters

id: string

Returns Promise<undefined | { accountId: string; webId: string; }>

handle

Returns Promise<void>

handleSafe

Parameters

input: void

Returns Promise<void>

isLinked

Parameters

webId: string

accountId: string

Returns Promise<boolean>

Settings

Member Visibility

Theme

On This Page

`Private` initialized

`Private` `Readonly` logger

`Private` `Readonly` storage

webIdLink: {
accountId: "id:account";
webId: "string";
}

`Readonly` accountId: "id:account"

`Readonly` webId: "string"

Returns Promise<{
id: string;
webId: string;
}[]>

Returns Promise<undefined | {
accountId: string;
webId: string;
}>