Vana SDK - v2.2.2
    Preparing search index...

    Interface UploadFileParams

    Defines parameters for uploading files to storage providers with encryption options.

    Used with DataController upload methods and storage operations. Supports multiple content formats, optional encryption, and custom storage provider selection with comprehensive metadata tracking.

    Use UploadParams with vana.data.upload() instead for the high-level API

    const uploadParams: UploadFileParams = {
      content: new TextEncoder().encode(JSON.stringify(userData)),
      metadata: {
        name: "personal-profile.json",
        mimeType: "application/json",
        size: 2048,
      },
      storageProvider: "ipfs",
      encrypt: true,
    };

    const result = await vana.data.uploadFile(uploadParams);
    interface UploadFileParams {
        content: string | Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>;
        metadata?: FileMetadata;
        storageProvider?: string;
        encrypt?: boolean;
        encryptionKey?: string;
    }
    Index

    Properties

    content metadata? storageProvider? encrypt? encryptionKey?

    Properties

    content

    content: string | Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

    Raw file data in bytes, buffer, or string format.

    metadata?: FileMetadata

    Descriptive metadata for file organization and tracking.

    storageProvider?: string

    Storage provider name ("ipfs" or custom provider, uses configured default if unspecified).

    encrypt?: boolean

    Enables automatic encryption before upload to storage (defaults to false).

    encryptionKey?: string

    Custom encryption key (auto-generated if encryption enabled and not provided).

    Settings

    Member Visibility

    On This Page

    Properties