TypeScript types
All exported TypeScript types from @ipfs-meshkit/meshkit.
All types are exported from @ipfs-meshkit/meshkit and can be imported with import type:
import type { Meshkit, IPFSNodeHandle, IpnsKey } from '@ipfs-meshkit/meshkit';
| Type | Description |
|---|
MeshkitBootstrapOptions | Options for init() |
MeshkitBootstrapResult | Return value of init() — { meshkit, localNode? } |
LocalNodeOption | boolean | StartIPFSNodeOptions |
| Type | Description |
|---|
Meshkit | Multi-node client interface |
MeshkitClient | Single-node client interface |
MeshkitConfig | Config for createMeshkitClient — { apiUrl, headers? } |
MeshkitInitOptions | Options for Meshkit.init() — { nodes, headers? } |
| Type | Description |
|---|
IPFSNodeHandle | Daemon handle — url, repo?, managed, stop() |
StartIPFSNodeOptions | Options for startIPFSNode() |
GracefulShutdownOptions | Options for setupGracefulShutdown() |
| Type | Description |
|---|
IpnsDuration | Kubo duration string, e.g. "1m", "24h" |
IpnsKey | { id: string, name: string } |
IpnsKeyGenOptions | { type?: 'ed25519' | 'rsa', size?: number } |
IpnsPublishOptions | { key?, lifetime?, ttl?, resolve? } |
IpnsPublishResult | { name: string, value: string } |
IpnsResolveOptions | { recursive?, nocache? } |
| Type | Description |
|---|
EncryptOptions | { password: string; iterations?: number } — iterations ≥ 1,000 |
UploadOptions | { encrypt?: EncryptOptions } |
RetrieveOptions | { password?: string } |
DEFAULT_ITERATIONS is the runtime constant 200_000, not a type. encrypt, decrypt, and isEncryptedPayload are value exports documented in Encryption.
| Class | Extends | Key properties |
|---|
MeshkitError | Error | causes: Error[] |
MeshkitNodeError | Error | cause?: unknown (native) |
