Skip to content
This repository has been archived by the owner on Jul 24, 2024. It is now read-only.

docs: Add some more Binary Config details #2456

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -569,12 +569,12 @@ When compiling a directory `--source-map` can either be a boolean value or a dir

node-sass supports different configuration parameters to change settings related to the sass binary such as binary name, binary path or alternative download path. Following parameters are supported by node-sass:

Variable name | .npmrc parameter | Process argument | Value
-----------------|------------------|--------------------|------
SASS_BINARY_NAME | sass_binary_name | --sass-binary-name | path
SASS_BINARY_SITE | sass_binary_site | --sass-binary-site | URL
SASS_BINARY_PATH | sass_binary_path | --sass-binary-path | path
SASS_BINARY_DIR | sass_binary_dir | --sass-binary-dir | path
Variable name | .npmrc parameter | Process argument | Value | Example
-----------------|------------------|--------------------|-------|----------------------------
SASS_BINARY_NAME | sass_binary_name | --sass-binary-name | path | win32-x64-57
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

binary name includes the .node extension

assert.equal(sass.getBinaryName(), 'aaa_binding.node');

SASS_BINARY_SITE | sass_binary_site | --sass-binary-site | URL | http://example.com/
SASS_BINARY_PATH | sass_binary_path | --sass-binary-path | path | /usr/var/local/binding.node
SASS_BINARY_DIR | sass_binary_dir | --sass-binary-dir | path | /usr/var/my_cache/

These parameters can be used as environment variable:

Expand Down