1 | # Installation
|
2 | > `npm install --save @types/conventional-changelog`
|
3 |
|
4 | # Summary
|
5 | This package contains type definitions for conventional-changelog (https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog#readme).
|
6 |
|
7 | # Details
|
8 | Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/conventional-changelog.
|
9 | ## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/conventional-changelog/index.d.ts)
|
10 | ````ts
|
11 | // Type definitions for conventional-changelog 3.1
|
12 | // Project: https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog#readme
|
13 | // Definitions by: Jason Kwok <https://github.com/JasonHK>
|
14 | // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
15 | // TypeScript Version: 2.9
|
16 |
|
17 | /// <reference types="node" />
|
18 |
|
19 | import * as Stream from "stream";
|
20 |
|
21 | import {
|
22 | Context,
|
23 | GitRawCommitsOptions,
|
24 | ParserOptions,
|
25 | WriterOptions,
|
26 | Options as BaseOptions,
|
27 | } from "conventional-changelog-core";
|
28 | import { Context as WriterContext } from "conventional-changelog-writer";
|
29 | import { Commit } from "conventional-commits-parser";
|
30 |
|
31 | /**
|
32 | * Returns a readable stream.
|
33 | *
|
34 | * @param options
|
35 | * @param context
|
36 | * @param gitRawCommitsOpts
|
37 | * @param parserOpts
|
38 | * @param writerOpts
|
39 | */
|
40 | // tslint:disable-next-line max-line-length
|
41 | declare function conventionalChangelog<TCommit extends Commit = Commit, TContext extends WriterContext = Context>(options?: Options<TCommit, TContext>, context?: Partial<TContext>, gitRawCommitsOpts?: GitRawCommitsOptions, parserOpts?: ParserOptions, writerOpts?: WriterOptions<TCommit, TContext>): Stream.Readable;
|
42 |
|
43 | declare namespace conventionalChangelog {
|
44 | /**
|
45 | * See the [conventional-changelog-core](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-core)
|
46 | * docs. The API is the same with the following changes or additions:
|
47 | */
|
48 | interface Options<TCommit extends Commit = Commit, TContext extends WriterContext = WriterContext> extends BaseOptions<TCommit, TContext> {
|
49 | /**
|
50 | * It's recommended to use a preset so you don't have to define everything
|
51 | * yourself. Presets are names of built-in `config`.
|
52 | *
|
53 | * A scoped preset package such as `@scope/conventional-changelog-custom-preset`
|
54 | * can be used by passing `@scope/custom-preset` to this option.
|
55 | *
|
56 | * @remarks
|
57 | * `options.config` will be overwritten by the values of preset. You should use
|
58 | * either `preset` or `config`, but not both.
|
59 | */
|
60 | preset?: string | undefined;
|
61 | }
|
62 | }
|
63 |
|
64 | type Options<TCommit extends Commit = Commit, TContext extends WriterContext = WriterContext> = conventionalChangelog.Options<TCommit, TContext>;
|
65 |
|
66 | export = conventionalChangelog;
|
67 |
|
68 | ````
|
69 |
|
70 | ### Additional Details
|
71 | * Last updated: Thu, 08 Jul 2021 09:08:11 GMT
|
72 | * Dependencies: [@types/conventional-changelog-core](https://npmjs.com/package/@types/conventional-changelog-core), [@types/conventional-changelog-writer](https://npmjs.com/package/@types/conventional-changelog-writer), [@types/conventional-commits-parser](https://npmjs.com/package/@types/conventional-commits-parser), [@types/node](https://npmjs.com/package/@types/node)
|
73 | * Global values: none
|
74 |
|
75 | # Credits
|
76 | These definitions were written by [Jason Kwok](https://github.com/JasonHK).
|
77 |
|
\ | No newline at end of file |