NPM Build Utilities @ 0.1.3
    Preparing search index...

    Interface Release

    The required shape for a release stage.

    ReleaseStage.ARGS_DEFAULT For defaults.

    0.1.0-alpha

    interface Release {
        commit: null | ((stage: Stage, defaultPaths?: string[]) => string[]);
        replace:
            | false
            | ((stage: Stage) => { package: string[]; ignore?: string[] });
        utils: { compiler?: Stage_Compiler; fs?: FileSystem };
    }

    Hierarchy (View Summary)

    Index

    Properties

    commit replace utils

    Properties

    commit: null | ((stage: Stage, defaultPaths?: string[]) => string[])

    Files to add to commit after packaging but before release.

    Type declaration

    • null
    • (stage: Stage, defaultPaths?: string[]) => string[]
        • (stage: Stage, defaultPaths?: string[]): string[]

        • Parameters

          • stage: Stage

            Instance of the current stage (probably ReleaseStage).

          • OptionaldefaultPaths: string[]

            The default paths to add to the commit.

          Returns string[]

          All relative or absolute paths to add to the commit.

    replace: false | ((stage: Stage) => { package: string[]; ignore?: string[] })

    Whether to include this sub-stage, or the configuration if so.

    utils: { compiler?: Stage_Compiler; fs?: FileSystem }

    Optional class instances to use.

    Settings

    Member Visibility

    On This Page

    Properties