非官方文檔,整理來自己官方文檔的文字與實例,方便速查。
為什麼要用 Sea.js ?
Sea.js 追求簡單、自然的程式碼書寫和組織方式,具有以下核心特性:
簡單友善的模組定義規範:Sea.js 遵循 CMD 規範,可以像 Node.js 一般書寫模組程式碼。
自然直覺的程式碼組織方式:依賴的自動載入、配置的簡潔清晰,可以讓我們更享受編碼的樂趣。
Sea.js 還提供常用插件,非常有助於開發調試和性能優化,並具有豐富的可擴展介面。
相容性
Sea.js 具備完善的測試案例,相容於所有主流瀏覽器:
Chrome 3+
Firefox 2+
Safari 3.2+
Opera 10+
IE 5.5+
Sea.js 可運作在 Mobile 端,包括 Hybrid 模式的 App 上。理論上,Sea.js 可以運行在任何瀏覽器引擎上。
seajs.configObject
alias Object
別名配置,配置之後可在模組中使用require呼叫 require('jquery');
seajs.config({ alias: { 'jquery': 'jquery/jquery/1.10.1/jquery' } });
define(function(require, exports, module) { //引用jQuery模块 var $ = require('jquery'); });
paths Object
設定路徑,方便跨目錄呼叫。透過靈活的設定path可以在不影響base的情況下指定到某個目錄。
seajs.config({ //设置路径 paths: { 'gallery': 'https://a.alipayobjects.com/gallery' }, // 设置别名,方便调用 alias: { 'underscore': 'gallery/underscore' } });
define(function(require, exports, module) { var _ = require('underscore'); //=> 加载的是 https://a.alipayobjects.com/gallery/underscore.js });
vars Object
變數配置。有些場景下,模組路徑在運行時才能確定,這時可以使用 vars 變數來配置。
vars 配置的是模組標識中的變數值,在模組標識中以 {key} 表示變數。
seajs.config({ // 变量配置 vars: { 'locale': 'zh-cn' } });
define(function(require, exports, module) { var lang = require('./i18n/{locale}.js'); //=> 加载的是 path/to/i18n/zh-cn.js });
map Array
此配置可對模組路徑進行對應修改,可用於路徑轉換、線上偵錯等。
seajs.config({ map: [ [ '.js', '-debug.js' ] ] });
define(function(require, exports, module) { var a = require('./a'); //=> 加载的是 path/to/a-debug.js });
preload Array
使用preload配置項,可以在普通模組載入前,事先載入並初始化好指定模組。
preload中的空字串會被忽略掉。
// 在老浏览器中,提前加载好 ES5 和 json 模块 seajs.config({ preload: [ Function.prototype.bind ? '' : 'es5-safe', this.JSON ? '' : 'json' ] });
注意:preload中的配置,需要等到 use 時才載入。如:
seajs.config({ preload: 'a' }); // 在加载 b 之前,会确保模块 a 已经加载并执行好 seajs.use('./b');
preload 設定不能放在模組檔案裡面:
seajs.config({ preload: 'a' }); define(function(require, exports) { // 此处执行时,不能保证模块 a 已经加载并执行好 });
debug Boolean
值為true時,載入器不會刪除動態插入的 script 標籤。插件也可以根據debug配置,來決策 log 等資訊的輸出。
baseString
Sea.js 在解析頂層識別時,會相對 base 路徑來解析。
注意:一般請不要配置 base 路徑,把 sea.js 放在適當的路徑往往比較簡單一致。
charsetString | Function
取得模組檔案時,