arkiv-sdk
    Preparing search index...

    Type Alias ArkivCreate

    Specification for creating new entities in Arkiv.

    This type defines all the parameters needed to create a new entity, including the data payload, expiration time, and metadata annotations for efficient querying and categorization.

    Using the new expiresIn API with seconds (recommended):

    const createSpec: ArkivCreate = {
      data: new TextEncoder().encode(JSON.stringify({ message: "Hello Arkiv" })),
      expiresIn: 86400, // Expires in 24 hours (86400 seconds)
      stringAnnotations: [
        new Annotation("type", "message"),
        new Annotation("category", "greeting")
      ],
      numericAnnotations: [
        new Annotation("priority", 1),
        new Annotation("timestamp", Date.now())
      ]
    };

    Using ExpirationTime builder (also recommended):

    const createSpec: ArkivCreate = {
      data: new TextEncoder().encode("Data"),
      expiresIn: ExpirationTime.fromHours(24), // More readable
      stringAnnotations: [],
      numericAnnotations: []
    };

    Using legacy BTL (deprecated):

    const createSpec: ArkivCreate = {
      data: new TextEncoder().encode(JSON.stringify({ message: "Hello Arkiv" })),
      btl: 1000, // Deprecated: use expiresIn instead
      stringAnnotations: [],
      numericAnnotations: []
    };
    type ArkivCreate = {
        btl?: number;
        data: Uint8Array;
        expiresIn?: number | ExpirationTime;
        numericAnnotations: NumericAnnotation[];
        stringAnnotations: StringAnnotation[];
    }
    Index

    Properties

    btl? data expiresIn? numericAnnotations stringAnnotations

    Properties

    btl?: number

    Use expiresIn instead. BTL will be removed in a future version. Block-to-Live: number of blocks after which the entity expires

    data: Uint8Array

    The binary data to store in the entity

    expiresIn?: number | ExpirationTime

    Expiration time for the entity in seconds, or ExpirationTime object (preferred over btl). When using number, it represents duration in seconds (not blocks).

    numericAnnotations: NumericAnnotation[]

    Numeric-valued metadata annotations for indexing and filtering

    stringAnnotations: StringAnnotation[]

    String-valued metadata annotations for querying and categorization

    Settings

    Member Visibility

    On This Page

    Properties