UNPKG

2.38 kBMarkdownView Raw
1# Installation
2> `npm install --save @types/gulp-sourcemaps`
3
4# Summary
5This package contains type definitions for gulp-sourcemaps (https://github.com/gulp-sourcemaps/gulp-sourcemaps).
6
7# Details
8Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-sourcemaps.
9## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-sourcemaps/index.d.ts)
10````ts
11// Type definitions for gulp-sourcemaps
12// Project: https://github.com/gulp-sourcemaps/gulp-sourcemaps
13// Definitions by: Phips Peter <https://github.com/pspeter3>
14// Concision <https://github.com/concision>
15// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
16
17/// <reference types="node"/>
18
19import File = require("vinyl");
20
21interface InitOptions {
22 loadMaps?: boolean | undefined;
23 debug?: boolean | undefined;
24}
25
26interface WriteMapper {
27 (file: string): string;
28}
29
30interface SourceMapMapper {
31 (sourcePath: string, file: File): string;
32}
33
34interface SourceUrlMapper {
35 (file: File): string;
36}
37
38interface MapFilenameMapper {
39 (mapFilePath: string): string;
40}
41
42interface CloneOptions {
43 contents?: boolean | undefined;
44 deep?: boolean | undefined;
45}
46
47interface WriteOptions {
48 addComment?: boolean | undefined;
49 includeContent?: boolean | undefined;
50 sourceRoot?: string | WriteMapper | undefined;
51 sourceMappingURLPrefix?: string | WriteMapper | undefined;
52 sourceMappingURL?: SourceUrlMapper | undefined;
53 destPath?: string | undefined;
54 mapFile?: MapFilenameMapper | undefined;
55 charset?: BufferEncoding | undefined;
56 clone?: boolean | CloneOptions | undefined;
57}
58
59export declare function init(opts?: InitOptions): NodeJS.ReadWriteStream;
60export declare function mapSources(mapper?: SourceMapMapper): NodeJS.ReadWriteStream;
61export declare function write(path?: string, opts?: WriteOptions): NodeJS.ReadWriteStream;
62export declare function write(opts?: WriteOptions): NodeJS.ReadWriteStream;
63
64````
65
66### Additional Details
67 * Last updated: Thu, 08 Jul 2021 14:22:35 GMT
68 * Dependencies: [@types/vinyl](https://npmjs.com/package/@types/vinyl), [@types/node](https://npmjs.com/package/@types/node)
69 * Global values: none
70
71# Credits
72These definitions were written by [Phips Peter](https://github.com/pspeter3), and [Concision](https://github.com/concision).
73
\No newline at end of file