Class: WebClient<ModelTypes>¶
web.WebClient
WebClient extends the Core class with authentication support in browser
environments.
It is exported by the web module.
import { WebClient } from '@self.id/web'
Type parameters¶
| Name | Type |
|---|---|
ModelTypes |
extends ModelTypeAliases = CoreModelTypes |
Hierarchy¶
Core<ModelTypes>
↳ WebClient
Constructors¶
constructor¶
• new WebClient<ModelTypes>(params)
Type parameters¶
| Name | Type |
|---|---|
ModelTypes |
extends ModelTypeAliases<Record<string, any>, Record<string, string>, Record<string, string>> = ModelTypes |
Parameters¶
| Name | Type |
|---|---|
params |
WebClientParams<ModelTypes> |
Overrides¶
Core<ModelTypes\>.constructor
Accessors¶
ceramic¶
• get ceramic(): CeramicClient
Ceramic HTTP Client instance used internally.
Returns¶
CeramicClient
Inherited from¶
Core.ceramic
dataModel¶
• get dataModel(): DataModel<ModelTypes, ModelTypesToAliases<ModelTypes>>
DataModel runtime instance used internally.
Returns¶
DataModel<ModelTypes, ModelTypesToAliases<ModelTypes>>
Inherited from¶
Core.dataModel
dataStore¶
• get dataStore(): DIDDataStore<ModelTypes, keyof ModelTypes["definitions"]>
DID DataStore instance used internally.
Returns¶
DIDDataStore<ModelTypes, keyof ModelTypes["definitions"]>
Inherited from¶
Core.dataStore
resolver¶
• get resolver(): Resolver
DID resolver instance used internally.
Returns¶
Resolver
Inherited from¶
Core.resolver
threeId¶
• get threeId(): ThreeIdConnect
3ID Connect instance used internally.
Returns¶
ThreeIdConnect
tileLoader¶
• get tileLoader(): TileLoader
Tile loader instance used internally.
Returns¶
TileLoader
Inherited from¶
Core.tileLoader
Methods¶
authenticate¶
▸ authenticate(authProvider, attachToCeramic?): Promise<DID>
Create and authenticate a DID instance using the given authProvider.
By default, this also attaches the created DID instance to the internal Ceramic client
instance. This behavior can be disabled by setting attachToCeramic to false.
Parameters¶
| Name | Type | Default value |
|---|---|---|
authProvider |
EthereumAuthProvider |
undefined |
attachToCeramic |
boolean |
true |
Returns¶
Promise<DID>
connect¶
▸ connect(authProvider): Promise<DID>
Create a DID instance using the given authProvider.
⚠️ This method does not attempt to authenticate immediately, use authenticate
instead if this is the wanted behavior.
Parameters¶
| Name | Type |
|---|---|
authProvider |
EthereumAuthProvider |
Returns¶
Promise<DID>
get¶
▸ get<Key, ContentType>(key, id): Promise<null | ContentType>
Load the record content for a given definition alias and account.
Uses toDID to resolve the account.
Type parameters¶
| Name | Type |
|---|---|
Key |
extends string | number | symbol |
ContentType |
DefinitionContentType<ModelTypes, Key> |
Parameters¶
| Name | Type |
|---|---|
key |
Key |
id |
string |
Returns¶
Promise<null | ContentType>
Inherited from¶
Core.get
getAccountDID¶
▸ getAccountDID(account): Promise<string>
Load the DID string for a given CAIP-10 account using a CAIP-10 link, or throw an error if not linked.
Parameters¶
| Name | Type |
|---|---|
account |
string |
Returns¶
Promise<string>
Inherited from¶
Core.getAccountDID
toDID¶
▸ toDID(accountOrDID): Promise<string>
Turn a DID or CAIP-10 string into a DID string.
If the input is a DID string, it will be returned as-is, otherwise
getAccountDID will be used.
Parameters¶
| Name | Type |
|---|---|
accountOrDID |
string |
Returns¶
Promise<string>
Inherited from¶
Core.toDID