aboutsummaryrefslogtreecommitdiff
path: root/tools/addon-sdk-1.5/packages/api-utils/lib/namespace.js
blob: b25284edbef5d0c25a2068163a4f05f8ff1fdf41 (plain)
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
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

"use strict";

/**
 * Function creates a new namespace. Optionally `prototype` object may be
 * passed, in which case namespace objects will inherit from it. Returned value
 * is a function that can be used to get access to the namespaced properties
 * for the passed object.
 * @examples
 *    const ns = Namespace();
 *    ns(myObject).secret = secret;
 */
exports.Namespace = function Namespace(prototype) {
  prototype = prototype || Object.prototype;
  const map = new WeakMap();
  return function namespace(target) {
    return map.get(target) ||
           map.set(target, Object.create(prototype)), map.get(target);
  };
};

// `Namespace` is a e4x function in the scope, so we export the function also as
// `ns` as alias to avoid clashing.
exports.ns = exports.Namespace;