IDX Web library

Browser only

IDX Web only targets browser environments, use the main IDX library instead if you need cross-platform support.

Installation

npm install @ceramicstudio/idx-web

Interfaces

EthereumAuthProvider

Class exported by the 3id-connect library

ThreeIdConnect

Class exported by the 3id-connect library

IDXWebOptions

Extends IDXOptions from the IDX library.

The Ceramic instance must be a Ceramic HTTP Client instance.

interface IDXWebOptions extends Omit<IDXOptions, 'ceramic'> {

ceramic?: Ceramic | string

connect?: ThreeIdConnect | string

}

EthereumProviderOptions

interface EthereumProviderOptions {

address: string

provider: unknown

}

WebAuthenticateOptions

Extends AuthenticateOptions from the IDX library

interface WebAuthenticateOptions extends AuthenticateOptions {

authProvider?: EthereumAuthProvider

ethereum?: EthereumProviderOptions

}

IDXWeb class

Extends IDX. The APIs documented below only describe the changes from the extended class.

constructor

Arguments

1. options: IDXWebOptions

.authenticate

Arguments

1. options?: WebAuthenticateOptions

Returns Promise<void>