Documentation
    Preparing search index...

    Interface PublisherGCSConfig

    interface PublisherGCSConfig {
        bucket?: string;
        folder?: string;
        keyResolver?: (
            opts: {
                arch: string;
                fileName: string;
                platform: string;
                version: string;
            },
        ) => string;
        metadataGenerator?: (artifact: GCSArtifact) => ConfigMetadata;
        storageOptions: StorageOptions;
        uploadOptions?: UploadOptions;
    }
    Index

    Properties

    bucket? folder? keyResolver? metadataGenerator? storageOptions uploadOptions?

    Properties

    bucket?: string

    The name of the Google Cloud Storage bucket where artifacts are uploaded.

    folder?: string

    The key prefix where artifacts are uploaded, e.g., my/prefix.

    Defaults to the application version specified in the app's package.json.

    keyResolver?: (
        opts: {
            arch: string;
            fileName: string;
            platform: string;
            version: string;
        },
    ) => string

    Custom function to provide the key to upload a given file to

    metadataGenerator?: (artifact: GCSArtifact) => ConfigMetadata

    Generate optional Metadata for GCS Objects See https://cloud.google.com/storage/docs/metadata for more info. Expects a function that takes a GCSArtifact object and returns a ConfigMetadata object.

    storageOptions: StorageOptions

    Options passed into the Storage client constructor. See https://cloud.google.com/nodejs/docs/reference/storage/latest/storage/storage for full reference.

    uploadOptions?: UploadOptions

    Upload options to provide directly to the GCS storage upload method

    Settings

    Member Visibility

    On This Page

    Properties