@types/generate-changelog

Installation

npm install --save @types/generate-changelog

Summary

This package contains type definitions for generate-changelog (https://github.com/lob/generate-changelog#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/generate-changelog.

index.d.ts

// Type definitions for generate-changelog 1.8
// Project: https://github.com/lob/generate-changelog#readme
// Definitions by: Florian Keller <https://github.com/ffflorian>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

export interface Options {
    /** allow unkown commit types */
    allowUnknown?: boolean | undefined;
    /** exclude listed commit types (e.g. `['chore', 'style', 'refactor']`) */
    exclude?: string[] | undefined;
    /** whether it should be a patch changelog */
    patch?: boolean | undefined;
    /** whether it should be a minor changelog */
    minor?: boolean | undefined;
    /** whether it should be a major changelog */
    major?: boolean | undefined;
    /** repo URL that will be used when linking commits */
    repoUrl?: string | undefined;
    /** generate from specific tag or range (e.g. `v1.2.3` or `v1.2.3..v1.2.4`)' */
    tag?: string | undefined;
}

export function generate(options: Options): Promise<string>;

Additional Details

• Last updated: Thu, 08 Jul 2021 12:02:02 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Florian Keller.