Reference
Types
Important MeshKit public types and interfaces.
Use this page to understand the operational meaning of common exported TypeScript types.
import type { MeshFile, MeshKitOptions, ShareCapsule } from "@meshkit/core";
export const meshkitOptions: MeshKitOptions = {
identity: "docs-device",
provider: { type: "local-dev" },
};
export function summarize(file: MeshFile, capsule?: ShareCapsule) {
return {
cid: file.cid,
encrypted: file.encrypted,
recipients: capsule?.recipients ?? [],
};
}
| Type | Meaning |
|---|
MeshKitClient | Main client with files, records, share, messages, identity, sync, providers, proofs, and advanced namespaces |
MeshKitOptions | Runtime options passed to createMeshkit |
MeshKitConfig | Document-shaped config accepted by createMeshkitFromConfig |
MeshKitProviderInput | Provider instance, provider name, or provider config object |
MeshTelemetryOptions | Event callback and sink behavior |
| Type | Meaning |
|---|
MeshFile | Stored encrypted object with CID, name, size, proof, encrypted flag, and helpers |
MeshContent | Decrypted content reader returned by files.get, open, or message open |
MeshBatch | Batch manifest plus child MeshFile entries |
MeshStreamFile | Stream manifest and root CID for chunked encrypted content |
MeshProof | Provider proof metadata for a CID |
| Type | Meaning |
|---|
ShareCapsule | Access record wrapping a content key for recipients |
ShareOptions | Expiry, policy, vault, capability, and download hint options |
OpenOptions | Identity and capability options for opening shared content |
IdentityRecord | Public and optional private identity export/import record |
MeshMessage | Mailbox entry backed by a share capsule |
| Type | Meaning |
|---|
MeshSyncJob | Durable sync or retry work record |
PersistenceProof | Filecoin or persistence provider proof record |
DoctorReport | Health checks for provider/runtime configuration |
ProviderLog | Sanitized provider operation log entry |
MeshKitError | Classified error with code, message, suggestion, and optional details |