Installation

npm install --save @types/gulp-ruby-sass

Summary

This package contains type definitions for gulp-ruby-sass (https://github.com/sindresorhus/gulp-ruby-sass).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-ruby-sass.

index.d.ts

1/// <reference types="node"/>
2
3/**
4 * The interface includes all options that available for sass executable.
5 * Options are converted from dashed to camelCase
6 * @interface SassOptions
7 */
8interface SassOptions {
9    loadPath?: string | string[] | undefined;
10    require?: string | undefined;
11    compass?: boolean | undefined;
12    style?: string | undefined;
13    force?: boolean | undefined;
14    stopOnError?: boolean | undefined;
15    scss?: boolean | undefined;
16    defaultEncoding?: string | undefined;
17    unixNewlines?: boolean | undefined;
18    debugInfo?: boolean | undefined;
19    lineNumbers?: boolean | undefined;
20    lineComments?: boolean | undefined;
21    check?: boolean | undefined;
22    precision?: number | undefined;
23    cacheLocation?: string | undefined;
24    noCache?: boolean | undefined;
25    trace?: boolean | undefined;
26    quiet?: boolean | undefined;
27
28    // Actually, there should be a string. However due to ts spec, overriding member should be the same type or a subtype.
29    // https://stackoverflow.com/questions/19605557/incompatible-static-properties-in-three-d-ts-with-latest-typescript
30    // We need Options.soucemap to be boolean, so here 'any' is used instead of string.
31    sourcemap?: any;
32
33    // All listed below options are acceptable by the sass executable and potentially may be used from js.
34    // However I doubt are there cases when it's meaningful
35    watch?: string | undefined;
36    update?: string | undefined;
37    stdin?: boolean | undefined;
38    interactive?: boolean | undefined;
39}
40
41/**
42 * The interface includes the node-ruby-sass only options.
43 * Attention: sourcemap option type differs from the same SassOption's type.
44 * @interface Options
45 */
46interface Options extends SassOptions {
47    verbose?: boolean | undefined;
48    bundleExec?: boolean | undefined;
49    sourcemap?: boolean | undefined;
50    container?: string | undefined;
51}
52
53/**
54 * Object to be exported
55 * @param {string} source - Filename or directory
56 * @param {Options} options - Additional processing rules/options
57 */
58declare function sass(source: string, options?: Options): NodeJS.ReadableStream;
59
60declare namespace sass {}
61
62export = sass;
63

Additional Details

• Last updated: Tue, 07 Nov 2023 03:09:37 GMT
• Dependencies: @types/node

Credits

These definitions were written by Agnislav Onufrijchuk.