UNPKG

2.06 kBMarkdownView Raw
1# Installation
2> `npm install --save @types/gulp-sass`
3
4# Summary
5This package contains type definitions for gulp-sass (https://github.com/dlmanning/gulp-sass).
6
7# Details
8Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-sass.
9## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-sass/index.d.ts)
10````ts
11// Type definitions for gulp-sass 5.0.0
12// Project: https://github.com/dlmanning/gulp-sass
13// Definitions by: Asana <https://asana.com>
14// Yuma Hashimoto <https://github.com/yuma84>
15// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
16// TypeScript Version: 2.7
17
18/// <reference types="node"/>
19
20import { Options } from 'node-sass';
21
22interface SassResults {
23 css: string;
24 map: string;
25 stats: {
26 entry: string;
27 start: Date;
28 end: Date;
29 duration: number;
30 includedFiles: string[];
31 }
32}
33
34interface SassOptions extends Options {
35 success?: ((results: SassResults) => any) | undefined;
36 error?: ((err: Error) => any) | undefined;
37 imagePaths?: string[] | undefined;
38}
39
40interface GulpSassOptions extends SassOptions {
41 errLogToConsole?: boolean | undefined;
42 onSuccess?: ((css: string) => any) | undefined;
43 onError?: ((err: Error) => any) | undefined;
44 sync?: boolean | undefined;
45}
46
47interface GulpSass {
48 (opts?: GulpSassOptions): NodeJS.ReadWriteStream;
49 logError(error?: string): void;
50 sync(options?: GulpSassOptions): NodeJS.ReadWriteStream;
51}
52
53type Compiler = any;
54
55interface GulpSassFactory {
56 (compiler: Compiler): GulpSass
57}
58
59declare var _tmp: GulpSassFactory;
60export = _tmp;
61
62````
63
64### Additional Details
65 * Last updated: Thu, 08 Jul 2021 14:22:34 GMT
66 * Dependencies: [@types/node-sass](https://npmjs.com/package/@types/node-sass), [@types/node](https://npmjs.com/package/@types/node)
67 * Global values: none
68
69# Credits
70These definitions were written by [Asana](https://asana.com), and [Yuma Hashimoto](https://github.com/yuma84).
71
\No newline at end of file