JavaScript API
require模块，用给定的Stylus代码字符串调用render()，以及（可选的）optional对象。
传递filename参数可以利用Stylus框架提供更好的错误报告。
1
2
3
4
5
6
| var stylus = require('stylus');
stylus.render(str, { filename: 'nesting.css' }, function(err, css){
if (err) throw err;
console.log(css);
});
|
我们可以用更渐进的方式实现做一样的事：
1
2
3
4
5
6
7
| var stylus = require('stylus');
stylus(str)
.set('filename', 'nesting.css')
.render(function(err, css){
// logic
});
|
.set(setting, value)
应用诸如filename的设置，或导入paths:
1
2
| .set('filename', __dirname + '/test.styl')
.set('paths', [__dirname, __dirname + '/mixins'])
|
.include(path)
渐进替换.set(‘paths’,…)的就是.include(). 当其他Stylus库（已暴露路径）暴露的时候，这个是理想的选择。
1
2
3
4
| stylus(str)
.include(require('nib').path)
.include(process.env.HOME + '/mixins')
.render(...)
|
.import(path)
推迟给定path导入，直到计算被执行。下面这个例子基本上跟在Stylus片段中执行@import ‘mixins/vendor’一样：
1
2
3
4
5
6
7
8
9
10
| var stylus = require('../')
, str = require('fs').readFileSync(__dirname + '/test.styl', 'utf8');
stylus(str)
.set('filename', __dirname + '/test.styl')
.import('mixins/vendor')
.render(function(err, css){
if (err) throw err;
console.log(css);
});
|
.define(name, node)
通过传递一个Node，我们可以定义一个全局变量。当库（该库依赖于其它库可用性）里面暴露某些条件特征的时候，这个就很有用。例如Nib扩展库条件支持node-canvas, 提供图片生成。
但这并不是一直可用的，因此Nib可以定义：
1
2
| .define('has-canvas', stylus.nodes.false);
.define('some-setting', new stylus.nodes.String('some value'));
|
如果可能，Stylus也会转换JavaScript值为Stylus值。
1
2
3
4
5
6
7
| .define('string', 'some string')
.define('number', 15.5)
.define('some-bool', true)
.define('list', [1,2,3])
.define('list', [1,2,[3,4,[5,6]]])
.define('list', { foo: 'bar', bar: 'baz' })
.define('families', ['Helvetica Neue', 'Helvetica', 'sans-serif'])
|
下面是一些规则应用在js函数返回值上：
1
2
3
| .define('get-list', function(){
return ['foo', 'bar', 'baz'];
})
|
.define(name, fn)
该方法允许你未Stylus提供JavaScript定义的函数。正如想到JavaScript用C++绑定。当有一些事情无法用Stylus完成的时候，就在JavaScript中定义它。
下面这个例子，我们定义了4个函数：add(), sub(), image-width(), image-height(). 这些函数必须返回一个Node, 通过stylus.nodes该构造以及其它nodes都可以了。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
| var stylus = require('../')
, nodes = stylus.nodes
, utils = stylus.utils
, fs = require('fs');
function add(a, b) {
return a.operate('+', b);
}
function sub(a, b) {
return a.operate('-', b);
}
function imageDimensions(img) {
// 宣告 node (img) 是一个 String 节点,
// 为错误报告传递参数名
utils.assertType(img, 'string', 'img');
var path = img.val;
// 得到尺寸有必要取得字节数
// 如果这是真的，你会每种格式都处理下，
// 而不是读取整个图片 :)
var data = fs.readFileSync(__dirname + '/' + path);
// GIF
// 当然，你可以支持更多 :)
if ('GIF' == data.slice(0, 3).toString()) {
var w = data.slice(6, 8)
, h = data.slice(8, 10);
w = w[1] << 8 | w[0];
h = h[1] << 8 | h[0];
}
return [w, h];
}
function imageWidth(img) {
return new nodes.Unit(imageDimensions(img)[0]);
}
function imageHeight(img) {
return new nodes.Unit(imageDimensions(img)[1]);
}
stylus(str)
.set('filename', 'js-functions.styl')
.define('add', add)
.define('sub', sub)
.define('image-width', imageWidth)
.define('image-height', imageHeight)
.render(function(err, css){
if (err) throw err;
console.log(css);
});
|
为了进一步的参考（直到本文档全部结束），请看下面的文件：
lib/nodes/*
lib/utils.js
.use(fn)
当被调用时，给定fn被渲染器调用，允许所有上面的方法被使用。这允许插件轻易地暴露自己，定义函数，路径等
1
2
3
4
5
6
7
8
| var mylib = function(style){
style.define('add', add);
style.define('sub', sub);
};
stylus(str)
.use(mylib)
.render(...)
|
当使用选项调用render()方法时，可以给use选项提供一个函数或一组函数，以便与渲染器一起调用。
1
2
3
4
| stylus.render(str, { use: mylib }, function(err, css){
if (err) throw err;
console.log(css);
});
|
.deps()
返回依赖项数组（导入文件）：
1
2
3
4
| stylus('@import "a"; @import "b"')
.deps();
// => ['a.styl', 'b.styl']
|
也可以查看 –deps CLI flag.
stylus.resolver([options])
可选的内置函数可用于解析导入文件中的相关URL：
1
2
3
4
5
| stylus(str)
.define('url', stylus.resolver())
.render(function(err, css) {
});
|
也可以查看 –resolve-url CLI flag.
Options:
paths additional resolution path(s)
nocheck don’t check file existence