Skip to main content

Module: @web3-storage/access

Namespaces

Classes

Functions

connection

connection<Service, T>(options?): ConnectionView<Service>

Creates a Ucanto connection for the w3access API

Usage:

import { connection } from '@web3-storage/access/agent'

Type parameters

NameTypeDescription
Serviceextends Service
Textends `did:${string}:${string}`DID method

Parameters

NameTypeDescription
options?Object
options.channelundefined | Channel<Service>Ucanto channel to use
options.fetchundefined | (input: URL | RequestInfo, init?: RequestInit) => Promise<Response>Fetch implementation to use
options.principalundefined | Principal<T>w3access API Principal
options.urlundefined | URLw3access API URL

Returns

ConnectionView<Service>

Defined in

packages/access-client/src/agent.js:49