Selva Compute API Reference - v2.1.0
    Preparing search index...

    Type Alias FileData

    Represents raw file data from Grasshopper/Rhino Compute response.

    This type encapsulates file output from compute operations, with metadata for processing (decoding, naming, organization). Files are typically combined with additional files and packaged into a ZIP archive for download.

    type FileData = {
        data: string;
        fileName: string;
        fileType: string;
        isBase64Encoded: boolean;
        metadata?: Record<string, string>;
        subFolder: string;
    }
    Index

    Properties

    data fileName fileType isBase64Encoded metadata? subFolder

    Properties

    data: string

    File content as a base64-encoded or plain string, depending on IsBase64Encoded

    fileName: string

    Base filename without extension (e.g., "model")

    fileType: string

    File extension including the dot (e.g., ".3dm", ".json"). Appended to FileName to create the full filename

    isBase64Encoded: boolean

    Whether Data is base64-encoded. If true, must be decoded to binary before use. If false, can be used as a plain text string

    metadata?: Record<string, string>

    Arbitrary user-supplied metadata (e.g. tags, indexing keys) attached in Grasshopper. Not interpreted by compute; passed through for downstream consumers. May be absent on older payloads.

    subFolder: string

    Directory path for organizing the file in archive structures (e.g., ZIP). Typically empty string for root-level files, or a path like "subfolder/nested"

    Settings

    Member Visibility

    On This Page

    Properties