@types/node-sass

Version 4.11.8
Published 22 days ago
18.9 kB
1 dependency
MIT license

Install

npm i @types/node-sass

yarn add @types/node-sass

pnpm add @types/node-sass

Overview

TypeScript definitions for node-sass

Index

Variables

FALSE
info
NULL
TRUE

Functions

render()
renderSync()

Variables

variable FALSE

const FALSE: types.Boolean;

variable info

const info: string;

variable NULL

const NULL: types.Null;

variable TRUE

const TRUE: types.Boolean;

Functions

function render

render: (options: Options, callback: SassRenderCallback) => void;

function renderSync

renderSync: (options: SyncOptions) => Result;

Interfaces

interface AsyncContext

interface AsyncContext extends Context {}

property callback

callback: SassRenderCallback;

interface Context

interface Context {}

The context value is a value that is shared for the duration of a single render. The context object is the implicit this for importers and sass functions that are implemented in javascript.
A render can be detected as asynchronous if the callback property is set on the context object.

property callback

callback: SassRenderCallback | undefined;

property options

options: Options;

index signature

[data: string]: any;

interface Options

interface Options {}

property data

data?: string | undefined;

property file

file?: string | undefined;

property functions

functions?: FunctionDeclarations | undefined;

property importer

importer?: Importer | Importer[] | undefined;

property includePaths

includePaths?: string[] | undefined;

property indentedSyntax

indentedSyntax?: boolean | undefined;

property indentType

indentType?: string | undefined;

property indentWidth

indentWidth?: number | undefined;

property linefeed

linefeed?: string | undefined;

property omitSourceMapUrl

omitSourceMapUrl?: boolean | undefined;

property outFile

outFile?: string | undefined;

property outputStyle

outputStyle?: 'compact' | 'compressed' | 'expanded' | 'nested' | undefined;

property precision

precision?: number | undefined;

property sourceComments

sourceComments?: boolean | undefined;

property sourceMap

sourceMap?: boolean | string | undefined;

property sourceMapContents

sourceMapContents?: boolean | undefined;

property sourceMapEmbed

sourceMapEmbed?: boolean | undefined;

property sourceMapRoot

sourceMapRoot?: string | undefined;

index signature

[key: string]: any;

interface Result

interface Result {}

The result of successfully compiling a Sass file.

property css

css: Buffer;

property map

map: Buffer;

property stats

stats: {
    entry: string;
    start: number;
    end: number;
    duration: number;
    includedFiles: string[];
};

interface SassError

interface SassError extends Error {}

The error object returned to javascript by sass's render methods.
This is not the same thing as types.Error.

property column

column: number;

property file

file: string;

property line

line: number;

property message

message: string;

property status

status: number;

interface SyncContext

interface SyncContext extends Context {}

property callback

callback: undefined;

interface SyncOptions

interface SyncOptions extends Options {}

property functions

functions?: FunctionDeclarations<SyncSassFunction> | undefined;

property importer

importer?: SyncImporter | SyncImporter[] | undefined;

Type Aliases

type AsyncImporter

type AsyncImporter = (
    this: AsyncContext,
    url: string,
    prev: string,
    done: (data: ImporterReturnType) => void
) => void;

type AsyncSassFn0

type AsyncSassFn0 = (this: AsyncContext, cb: SassFunctionCallback) => void;

type AsyncSassFn1

type AsyncSassFn1 = (
    this: AsyncContext,
    $arg1: types.Value,
    cb: SassFunctionCallback
) => void;

type AsyncSassFn2

type AsyncSassFn2 = (
    this: AsyncContext,
    $arg1: types.Value,
    $arg2: types.Value,
    cb: SassFunctionCallback
) => void;

type AsyncSassFn3

type AsyncSassFn3 = (
    this: AsyncContext,
    $arg1: types.Value,
    $arg2: types.Value,
    $arg3: types.Value,
    cb: SassFunctionCallback
) => void;

type AsyncSassFn4

type AsyncSassFn4 = (
    this: AsyncContext,
    $arg1: types.Value,
    $arg2: types.Value,
    $arg3: types.Value,
    $arg4: types.Value,
    cb: SassFunctionCallback
) => void;

type AsyncSassFn5

type AsyncSassFn5 = (
    this: AsyncContext,
    $arg1: types.Value,
    $arg2: types.Value,
    $arg3: types.Value,
    $arg4: types.Value,
    $arg5: types.Value,
    cb: SassFunctionCallback
) => void;

type AsyncSassFn6

type AsyncSassFn6 = (
    this: AsyncContext,
    $arg1: types.Value,
    $arg2: types.Value,
    $arg3: types.Value,
    $arg4: types.Value,
    $arg5: types.Value,
    $arg6: types.Value,
    cb: SassFunctionCallback
) => void;

type AsyncSassFunction

type AsyncSassFunction =
    | AsyncSassFn0
    | AsyncSassFn1
    | AsyncSassFn2
    | AsyncSassFn3
    | AsyncSassFn4
    | AsyncSassFn5
    | AsyncSassFn6
    | AsyncSassVarArgFn1
    | AsyncSassVarArgFn2
    | AsyncSassVarArgFn3
    | AsyncSassVarArgFn4
    | AsyncSassVarArgFn5
    | AsyncSassVarArgFn6;

type AsyncSassVarArgFn1

type AsyncSassVarArgFn1 = (
    this: AsyncContext,
    $arg1: types.Value[],
    cb: SassFunctionCallback
) => void;

type AsyncSassVarArgFn2

type AsyncSassVarArgFn2 = (
    this: AsyncContext,
    $arg1: types.Value,
    $arg2: types.Value[],
    cb: SassFunctionCallback
) => void;

type AsyncSassVarArgFn3

type AsyncSassVarArgFn3 = (
    this: AsyncContext,
    $arg1: types.Value,
    $arg2: types.Value,
    $arg3: types.Value[],
    cb: SassFunctionCallback
) => void;

type AsyncSassVarArgFn4

type AsyncSassVarArgFn4 = (
    this: AsyncContext,
    $arg1: types.Value,
    $arg2: types.Value,
    $arg3: types.Value,
    $arg4: types.Value[],
    cb: SassFunctionCallback
) => void;

type AsyncSassVarArgFn5

type AsyncSassVarArgFn5 = (
    this: AsyncContext,
    $arg1: types.Value,
    $arg2: types.Value,
    $arg3: types.Value,
    $arg4: types.Value,
    $arg5: types.Value[],
    cb: SassFunctionCallback
) => void;

type AsyncSassVarArgFn6

type AsyncSassVarArgFn6 = (
    this: AsyncContext,
    $arg1: types.Value,
    $arg2: types.Value,
    $arg3: types.Value,
    $arg4: types.Value,
    $arg5: types.Value,
    $arg6: types.Value[],
    cb: SassFunctionCallback
) => void;

type FunctionDeclarations

type FunctionDeclarations<FunctionType extends SassFunction = SassFunction> = Record<
    string,
    FunctionType
>;

type Importer

type Importer = AsyncImporter | SyncImporter;

type ImporterReturnType

type ImporterReturnType =
    | { file: string }
    | { file?: string | undefined; contents: string }
    | Error
    | null
    | types.Null
    | types.Error;

type SassFunction

type SassFunction = SyncSassFunction | AsyncSassFunction;

type SassFunctionCallback

type SassFunctionCallback = ($result: types.ReturnValue) => void;

type SassRenderCallback

type SassRenderCallback = (err: SassError, result: Result) => any;

type SyncImporter

type SyncImporter = (
    this: SyncContext,
    url: string,
    prev: string
) => ImporterReturnType;

type SyncSassFn

type SyncSassFn = (this: SyncContext, ...$args: types.Value[]) => types.ReturnValue;

type SyncSassFunction

type SyncSassFunction =
    | SyncSassFn
    | SyncSassVarArgFn1
    | SyncSassVarArgFn2
    | SyncSassVarArgFn3
    | SyncSassVarArgFn4
    | SyncSassVarArgFn5
    | SyncSassVarArgFn6;

type SyncSassVarArgFn1

type SyncSassVarArgFn1 = (
    this: SyncContext,
    $arg1: types.Value[]
) => types.ReturnValue;

type SyncSassVarArgFn2

type SyncSassVarArgFn2 = (
    this: SyncContext,
    $arg1: types.Value,
    $arg2: types.Value[]
) => types.ReturnValue;

type SyncSassVarArgFn3

type SyncSassVarArgFn3 = (
    this: SyncContext,
    $arg1: types.Value,
    $arg2: types.Value,
    $arg3: types.Value[]
) => types.ReturnValue;

type SyncSassVarArgFn4

type SyncSassVarArgFn4 = (
    this: SyncContext,
    $arg1: types.Value,
    $arg2: types.Value,
    $arg3: types.Value,
    $arg4: types.Value[]
) => types.ReturnValue;

type SyncSassVarArgFn5

type SyncSassVarArgFn5 = (
    this: SyncContext,
    $arg1: types.Value,
    $arg2: types.Value,
    $arg3: types.Value,
    $arg4: types.Value,
    $arg5: types.Value[]
) => types.ReturnValue;

type SyncSassVarArgFn6

type SyncSassVarArgFn6 = (
    this: SyncContext,
    $arg1: types.Value,
    $arg2: types.Value,
    $arg3: types.Value,
    $arg4: types.Value,
    $arg5: types.Value,
    $arg6: types.Value[]
) => types.ReturnValue;

Namespaces

namespace types

namespace types {}

variable Boolean

const Boolean: BooleanConstructor;

variable Color

const Color: ColorConstructor;

variable Error

const Error: ErrorConstructor;

variable List

const List: ListConstructor;

variable Map

const Map: MapConstructor;

variable Null

const Null: NullConstructor;

variable Number

const Number: NumberConstructor;

variable String

const String: StringConstructor;

interface Boolean

interface Boolean {}

method getValue

getValue: () => boolean;

interface BooleanConstructor

interface BooleanConstructor {}

property FALSE

FALSE: Boolean;

property TRUE

TRUE: Boolean;

call signature

(bool: boolean): Boolean;

interface Color

interface Color {}

method getA

getA: () => number;

Get the alpha transparency component of the color.
Returns
number between 0 and 1 inclusive;

method getB

getB: () => number;

Get the blue component of the color.
Returns
integer between 0 and 255 inclusive;

method getG

getG: () => number;

Get the green component of the color.
Returns
integer between 0 and 255 inclusive;

method getR

getR: () => number;

Get the red component of the color.
Returns
integer between 0 and 255 inclusive;

method setA

setA: (a: number) => void;

Set the alpha component of the color.
Parameter a
number between 0 and 1 inclusive;

method setB

setB: (b: number) => void;

Set the blue component of the color.
Parameter b
integer between 0 and 255 inclusive;

method setG

setG: (g: number) => void;

Set the green component of the color.
Parameter g
integer between 0 and 255 inclusive;

method setR

setR: (r: number) => void;

Set the red component of the color.
Returns
integer between 0 and 255 inclusive;

interface ColorConstructor

interface ColorConstructor {}

construct signature

new (r: number, g: number, b: number, a?: number): Color;

Constructs a new Sass color given the RGBA component values. Do not invoke with the new keyword.
Parameter r
integer 0-255 inclusive
Parameter g
integer 0-255 inclusive
Parameter b
integer 0-255 inclusive
Parameter a
float 0 - 1 inclusive
Returns
a SassColor instance.

construct signature

new (hexN: number): Color;

Constructs a new Sass color given a 4 byte number. Do not invoke with the new keyword.
If a single number is passed it is assumed to be a number that contains all the components which are extracted using bitmasks and bitshifting.
Parameter hexN
A number that is usually written in hexadecimal form. E.g. 0xff0088cc.
Returns
a Sass Color instance.
Example 1
// Comparison with byte array manipulation let a = new ArrayBuffer(4); let hexN = 0xCCFF0088; // 0xAARRGGBB let a32 = new Uint32Array(a); // Uint32Array [ 0 ] a32[0] = hexN; let a8 = new Uint8Array(a); // Uint8Array [ 136, 0, 255, 204 ] let componentBytes = [a8[2], a8[1], a8[0], a8[3] / 255] // [ 136, 0, 255, 0.8 ] let c = sass.types.Color(hexN); let components = [c.getR(), c.getG(), c.getR(), c.getA()] // [ 136, 0, 255, 0.8 ] assert.deepEqual(componentBytes, components); // does not raise.

call signature

(r: number, g: number, b: number, a?: number): Color;

Constructs a new Sass color given the RGBA component values. Do not invoke with the new keyword.
Parameter r
integer 0-255 inclusive
Parameter g
integer 0-255 inclusive
Parameter b
integer 0-255 inclusive
Parameter a
float 0 - 1 inclusive
Returns
a SassColor instance.

call signature

(hexN: number): Color;

Constructs a new Sass color given a 4 byte number. Do not invoke with the new keyword.
If a single number is passed it is assumed to be a number that contains all the components which are extracted using bitmasks and bitshifting.
Parameter hexN
A number that is usually written in hexadecimal form. E.g. 0xff0088cc.
Returns
a Sass Color instance.
Example 1
// Comparison with byte array manipulation let a = new ArrayBuffer(4); let hexN = 0xCCFF0088; // 0xAARRGGBB let a32 = new Uint32Array(a); // Uint32Array [ 0 ] a32[0] = hexN; let a8 = new Uint8Array(a); // Uint8Array [ 136, 0, 255, 204 ] let componentBytes = [a8[2], a8[1], a8[0], a8[3] / 255] // [ 136, 0, 255, 0.8 ] let c = sass.types.Color(hexN); let components = [c.getR(), c.getG(), c.getR(), c.getA()] // [ 136, 0, 255, 0.8 ] assert.deepEqual(componentBytes, components); // does not raise.

interface Enumerable

interface Enumerable {}

method getLength

getLength: () => number;

method getValue

getValue: (index: number) => Value;

method setValue

setValue: (index: number, value: Value) => void;

interface Error

interface Error {}

interface ErrorConstructor

interface ErrorConstructor {}

construct signature

new (message: string): Error;

An error return value for async functions. For synchronous functions, this can be returned or a standard error object can be thrown.

call signature

(message: string): Error;

An error return value for async functions. For synchronous functions, this can be returned or a standard error object can be thrown.

interface List

interface List extends Enumerable {}

method getSeparator

getSeparator: () => boolean;

method setSeparator

setSeparator: (isComma: boolean) => void;

interface ListConstructor

interface ListConstructor {}

construct signature

new (length: number, commaSeparator?: boolean): List;

call signature

(length: number, commaSeparator?: boolean): List;

interface Map

interface Map extends Enumerable {}

method getKey

getKey: (index: number) => Value;

method setKey

setKey: (index: number, key: Value) => void;

interface MapConstructor

interface MapConstructor {}

construct signature

new (length: number): Map;

call signature

(length: number): Map;

interface Null

interface Null {}

interface NullConstructor

interface NullConstructor {}

property NULL

NULL: Null;

call signature

(): Null;

interface Number

interface Number {}

method getUnit

getUnit: () => string;

method getValue

getValue: () => number;

method setUnit

setUnit: (u: string) => void;

method setValue

setValue: (n: number) => void;

interface NumberConstructor

interface NumberConstructor {}

construct signature

new (value: number, unit?: string): Number;

Constructs a new Sass number. Does not require use of the new keyword.

call signature

(value: number, unit?: string): Number;

Constructs a new Sass number. Can also be used with the new keyword.

interface String

interface String {}

method getValue

getValue: () => string;

method setValue

setValue: (s: string) => void;

interface StringConstructor

interface StringConstructor {}

construct signature

new (value: string): String;

Constructs a new Sass string. Does not require use of the new keyword.

call signature

(value: string): String;

Constructs a new Sass string. Can also be used with the new keyword.

type ReturnValue

type ReturnValue = Value | Error;

Values that are legal to return to Sass from a javascript function.

type Value

type Value = Null | Number | String | Color | Boolean | List | Map;

Values that are received from Sass as an argument to a javascript function.

Package Files (1)

index.d.ts

Dependencies (1)

@types/node

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/node-sass.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/node-sass)

HTML

<a href="https://www.jsdocs.io/package/@types/node-sass"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 20 days ago.
Package analyzed in 4277 ms.
Missing or incorrect documentation? Open an issue for this package.