mise API - v0.0.0
    Preparing search index...

    Interface SyncSeams

    The CUBE reads and the upload a sync needs.

    const seams: SyncSeams = { ...syncSeams_cube, descriptor_upload: async () => ({ ok: true }) };
    interface SyncSeams {
        cubeDescriptor_read(
            name: string,
            version: string,
        ): Promise<Record<string, unknown> | null>;
        cubePlugins_read(): Promise<CubePluginRow[]>;
        descriptor_upload(
            descriptor: string,
            computes: string[],
        ): Promise<UploadAnswer>;
    }
    Index
    cubeDescriptor_read cubePlugins_read descriptor_upload

    • Reads one registered version whole: its fields and every parameter.

      Parameters

      • name: string

        The plugin's name.

      • version: string

        The version.

      Returns Promise<Record<string, unknown> | null>

      The plugin's fields with parameters, or null when CUBE has no such version.

    • Uploads one descriptor.

      Parameters

      • descriptor: string

        The descriptor's text.

      • computes: string[]

        Compute resources to register it on.

      Returns Promise<UploadAnswer>

      Whether CUBE registered it, and why not.

    Settings
    Member Visibility

    On This Page
    Methods