@basetenlabs/sandbox - v0.3.0
    Preparing search index...

    Interface ImagePushDirectoryRequest

    ImagePushRequest that builds a local build context directory. Needs a runtime with Node's filesystem API.

    interface ImagePushDirectoryRequest {
        callOptions?: CallOptions;
        defaultIgnoreFile?: ImageIgnoreFileFunc;
        directory: string;
        ignoreFileProcessor?: ImageIgnoreFileProcessor;
        name: string;
        pollIntervalMs?: number;
        tempFile?: boolean;
        timeoutMs?: number;
        wait?: boolean;
    }

    Hierarchy (View Summary)

    Index
    callOptions?: CallOptions
    defaultIgnoreFile?: ImageIgnoreFileFunc

    Filters directory when it has no .dockerignore. Defaults to defaultImageIgnoreFile. Pass () => false to push everything.

    directory: string

    Local directory holding the build context, with a Dockerfile at its root, which is zipped. Files keep their permissions, a link to a file within the directory stores a copy of the file, a link to a file outside it fails the push, a link to a directory stores an empty directory, and a broken link is left out.

    Paths are left out as a .dockerignore at the directory's root says, read through ignoreFileProcessor, or else by defaultIgnoreFile. The root Dockerfile and .dockerignore are always kept, as Docker keeps them.

    ignoreFileProcessor?: ImageIgnoreFileProcessor

    Parses the .dockerignore at the root of directory. Required if there is one; otherwise the push fails before anything is sent. This package has no .dockerignore parser of its own.

    name: string

    Repository name. Pushing to an existing name adds a new version to it.

    pollIntervalMs?: number

    Milliseconds between checks. Defaults to 3s.

    tempFile?: boolean

    Whether to zip into a temporary file, removed once uploaded, instead of in memory. Defaults to true. Needs Node's fs.openAsBlob.

    timeoutMs?: number

    Milliseconds to wait before giving up. Giving up does not stop the image's processing. Defaults to 900s.

    wait?: boolean

    Whether to return only once the image is ready to use, throwing ImageBuildError if it fails. Defaults to true.