aboutsummaryrefslogtreecommitdiff
path: root/tools/addon-sdk-1.7/packages/api-utils/docs/list.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/addon-sdk-1.7/packages/api-utils/docs/list.md')
-rw-r--r--tools/addon-sdk-1.7/packages/api-utils/docs/list.md98
1 files changed, 0 insertions, 98 deletions
diff --git a/tools/addon-sdk-1.7/packages/api-utils/docs/list.md b/tools/addon-sdk-1.7/packages/api-utils/docs/list.md
deleted file mode 100644
index fd70698..0000000
--- a/tools/addon-sdk-1.7/packages/api-utils/docs/list.md
+++ /dev/null
@@ -1,98 +0,0 @@
-<!-- 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/. -->
-
-<!-- contributed by Irakli Gozalishvili [gozala@mozilla.com] -->
-
-The `"list"` module provides base building blocks for composing lists.
-
-<api name="Iterable">
-@class
-Base trait that can be used to compose traits with non-standard
-enumeration behaviors.
-
-This trait is supposed to be used as part of a composition, since it only
-provides custom enumeration behavior to a composed object.
-It defines one required `_keyValueMap` property, that is used as a hash of
-"key-values" to iterate on during enumeration.
-
-<api name="Iterable">
-@constructor
-Constructs an `Iterable` object.
-</api>
-
-<api name="_keyValueMap">
-@property {Object}
-Hash map of key-values to iterate over. _Required_ property: that is, the
-property must be supplied by objects that compose this trait.
-_Note: That this property can be a getter if you need dynamic behavior._
-</api>
-
-</api>
-
-<api name="List">
-@class
-An ordered collection (also known as a sequence) disallowing duplicate
-elements. List is composed out of `Iterable`, therefore it provides custom
-enumeration behavior that is similar to array (enumerates only on the
-elements of the list).
-
-List is a base trait and is meant to be part of a
-composition, since all of its API is private except for the `length` property.
-
-**Examples:**
-
- var MyList = List.compose({
- add: function add(item1, item2, /*item3...*/) {
- Array.slice(arguments).forEach(this._add.bind(this));
- },
- remove: function remove(item1, item2, /*item3...*/) {
- Array.slice(arguments).forEach(this._remove.bind(this));
- }
- });
- MyList('foo', 'bar', 'baz').length == 3; // true
- new MyList('new', 'keyword').length == 2; // true
- MyList.apply(null, [1, 2, 3]).length == 3; // true
- let list = MyList();
- list.length == 0; // true
- list.add(1, 2, 3) == 3; // true
-
-<api name="List">
-@constructor
-Constructor can takes any number of elements and creates an instance of
-`List` populated with the specified elements.
-@param [element1] {Object|String|Number}
-@param [element2] {Object|String|Number}
-@param [...] {Object|String|Number}
-</api>
-
-<api name="length">
-@property {Number}
-Number of elements in this list.
-</api>
-
-<api name="_has">
-@method
-@param element {Object|Number|String}
-Returns `true` if this list contains the specified `element`.
-</api>
-<api name="_add">
-@method
-@param element {Object|Number|String}
-Appends the specified `element` to the end of this list, if it doesn't
-contain it.
-
-_Ignores the call if `element` is already contained._
-</api>
-<api name="_remove">
-@method
-@param element {Object|Number|String}
-Removes specified `element` from this list, if it contains it.
-
-_Ignores the call if `element` is not contained._
-</api>
-<api name="_clear">
-@method
-Removes all of the elements from this list.
-</api>
-</api>