import PackageImporter from 'node-sass-package-importer/js/lib/PackageImporter.js'

public class | source

PackageImporter

Import packages from the node_modules directory.

Test:

PackageImporter

Constructor Summary

Public Constructor
public	constructor(options: Object)

Member Summary

Public Members
public	options: Object

Method Summary

Public Methods
public	cleanUrl(url: string): string Clean a node sass import url.
public	resolve(url: string): Promise Asynchronously resolve the path to a node-sass import url.
public	resolveFilter(pkg: Object): Object Find the first matching key in a package.json file and set it as value for the `main` field.
public	resolveSync(url: string): string Synchronously resolve the path to a node-sass import url.
public	urlVariants(url: string): Array Create url variants for partial file matching (e.g.

Public Constructors

public constructor(options: Object) source

Params:

Name	Type	Attribute	Description
options	Object		Configuration options.

Public Members

public options: Object source

Public Methods

public cleanUrl(url: string): string source

Clean a node sass import url.

Params:

Name	Type	Attribute	Description
url	string		Import url from node-sass.

Return:

string

Cleaned url.

Test:

PackageImporter cleanUrl()

public resolve(url: string): Promise source

Asynchronously resolve the path to a node-sass import url.

Params:

Name	Type	Attribute	Description
url	string		Import url from node-sass.

Return:

Promise

Promise for a fully resolved import url.

Test:

PackageImporter resolve()

public resolveFilter(pkg: Object): Object source

Find the first matching key in a package.json file and set it as value for the main field.

Params:

Name	Type	Attribute	Description
pkg	Object		Contents of a package.json.

Return:

Object

A package.json object with a replaced main value.

Test:

PackageImporter resolveFilter()

public resolveSync(url: string): string source

Synchronously resolve the path to a node-sass import url.

Params:

Name	Type	Attribute	Description
url	string		Import url from node-sass.

Return:

string

Fully resolved import url or null.

Test:

PackageImporter resolveSync()

public urlVariants(url: string): Array source

Create url variants for partial file matching (e.g. _file.scss).

Params:

Name	Type	Attribute	Description
url	string		Import url from node-sass.

Return:

Array

Multiple variants of sass file names.

Test:

PackageImporter urlVariants()