diff --git a/docs/Channel.html b/docs/Channel.html new file mode 100644 index 0000000..414f5d4 --- /dev/null +++ b/docs/Channel.html @@ -0,0 +1,2699 @@ + + + + + Channel - Documentation + + + + + + + + + + + + + + + + +
+ +

Channel

+ + + + + + + +
+ +
+ +

+ Channel +

+ + +
+ +
+
+ + + + + +

new Channel(targetopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ Calling the `Channel` function creates a new message channel over which messages can be sent. The function adds methods to an object that allow for listening to and triggering events. You can pass in an object to transform it into a message channel or a string to create a public named channel. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
target + + +Object + + + + + + <optional>
+ + + + + + 		An object that is to be transormed into an event channel. If no object is given, a new one is being created.
+ + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + +

Methods

+ + + + + + +

emit(type) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ Calling this method triggers the specified event and will result in all registered callbacks being executed. +You should no rely on the order in which the callbacks are being invoked. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +String + + + + The name of the event to be triggered. Any additional arguments will be passed to + the callback function.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

emitAsync(type) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ This method works like `emit` but guarantees asynchronous execution of all callbacks for this event. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +String + + + + The name of the event to be triggered. Any additional arguments will be passed to + the callback function.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

emitSync(type) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ This method works like `emit` but guarantees synchronous execution of all callbacks for this event. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +String + + + + The name of the event to be triggered. Any additional arguments will be passed to + the callback function.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

isLocked(typeopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ Returns whether the channel or a specifc event type on this channel is locked. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +String + + + + + + <optional>
+ + + + + + 		Optional: The name of the event whose status is being requested. If no event type is specified, the whole channel's status will be returned.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

isSilenced(typeopt, funcopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ Returns whether the channel or an event type or a specific callback is silenced. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +String + + + + + + <optional>
+ + + + + + 		Optional: The name of the event whose status is being requested. + If no event type is specified, the whole channel's status will be returned.
func + + +function + + + + + + <optional>
+ + + + + + 		Optional: The function whose status is being requested. + If no function is specified the whole event type's status will be returned.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

lock(typeopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ `Lock` prevents new callbacks from being added. Affects the entire channel or specific events. +Does not affect public channels at all. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +String + + + + + + <optional>
+ + + + + + 		Optional: The name of the event to which no new callbacks shall be registerd. + If no event name is specified, the whole channel will be locked.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

off(typeopt, funcopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ This method allows it to remove event listeners. If a reference to a function is given, +only that function is removed. If only the type is given, all callbacks are removed from that event. +If no arguments are passed, all callbacks on all events are removed. +On public channels, only the first option (with both a type and a function reference) is permitted. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +String + + + + + + <optional>
+ + + + + + 		Optional: The event name of the callbacks to be removed.
func + + +function + + + + + + <optional>
+ + + + + + 		Optional: The callback function to be removed.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

on(type, func, ctxopt, asyncopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ With this method you can register callbacks to be executed when a certain event is triggered. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +String + + + + + + + + + + The name of the event is specified by a string. It doesn't matter, + whether this event name already exists or not.
func + + +function + + + + + + + + + + The function to be called, when the event is triggered.
ctx + + +Object + + + + + + <optional>
+ + + + + + 		Optionally, you can provide a context for the callback function.
async + + +boolean + + + + + + <optional>
+ + + + + + 		A preference regarding whether this callback shall the executed asynchronously. + (Not a guarantee!)
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

once(type, func, ctxopt, asyncopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ This method does the same as `on` but it registers a callback that will only be executed once. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +String + + + + + + + + + + The name of the event is specified by a string. It doesn't matter, whether this event name already exists or not.
func + + +function + + + + + + + + + + The function to be called, when the event is triggered.
ctx + + +Object + + + + + + <optional>
+ + + + + + 		Optionally, you can provide a context for the callback function.
async + + +boolean + + + + + + <optional>
+ + + + + + 		A preference regarding whether this callback shall the executed + asynchronously. (Not a guarantee!)
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

reset(typeopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ This lets you remove all event listeners from the message channel or from a specified event type. +(Also sets `silenced` and `locked` to `false`). +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +String + + + + + + <optional>
+ + + + + + 		Optional: The name of the event whose callbacks shall be removed. + If no event type is given, the whole channel will be reset.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

silence(Optional:, Optional:) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ The `silence` method prevents any new messages from being sent over the message channel. +Affects the entire channel or specific events or even specific callbacks. +Does not affect public channels at all. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
Optional: + + +String + + + + The name of the event that is meant to be silenced. + If no event type is specified, the whole channel will be silenced.
Optional: + + +function + + + + The function that is no longer to be executed when the event is triggered. + If no function is specified the whole event type will be silenced.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

unlock(typeopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ Unlock allows callbacks from being added to a channel after it was locked. + +This method does not check if the channel is public, because if it were, it could not +have been locked in the first place. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +String + + + + + + <optional>
+ + + + + + 		Optional: The name of the event that shall accept new callbacks again.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

unsilence(typeopt, funcopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ With this method you can enable message sending after it was disable using `silence`. + +This method does not check if the channel is public, because if it were, it could not +have been silenced in the first place. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +String + + + + + + <optional>
+ + + + + + 		Optional: The name of the event that is meant to be unsilenced.
func + + +function + + + + + + <optional>
+ + + + + + 		Optional: The function that shall be executed again, after being silenced.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + + +
+ +
+ + + + +
+ +
+ + + + + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-Bold-webfont.eot b/docs/fonts/OpenSans-Bold-webfont.eot new file mode 100644 index 0000000..5d20d91 Binary files /dev/null and b/docs/fonts/OpenSans-Bold-webfont.eot differ diff --git a/docs/fonts/OpenSans-Bold-webfont.svg b/docs/fonts/OpenSans-Bold-webfont.svg new file mode 100644 index 0000000..3ed7be4 --- /dev/null +++ b/docs/fonts/OpenSans-Bold-webfont.svg @@ -0,0 +1,1830 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-Bold-webfont.woff b/docs/fonts/OpenSans-Bold-webfont.woff new file mode 100644 index 0000000..1205787 Binary files /dev/null and b/docs/fonts/OpenSans-Bold-webfont.woff differ diff --git a/docs/fonts/OpenSans-BoldItalic-webfont.eot b/docs/fonts/OpenSans-BoldItalic-webfont.eot new file mode 100644 index 0000000..1f639a1 Binary files /dev/null and b/docs/fonts/OpenSans-BoldItalic-webfont.eot differ diff --git a/docs/fonts/OpenSans-BoldItalic-webfont.svg b/docs/fonts/OpenSans-BoldItalic-webfont.svg new file mode 100644 index 0000000..6a2607b --- /dev/null +++ b/docs/fonts/OpenSans-BoldItalic-webfont.svg @@ -0,0 +1,1830 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-BoldItalic-webfont.woff b/docs/fonts/OpenSans-BoldItalic-webfont.woff new file mode 100644 index 0000000..ed760c0 Binary files /dev/null and b/docs/fonts/OpenSans-BoldItalic-webfont.woff differ diff --git a/docs/fonts/OpenSans-Italic-webfont.eot b/docs/fonts/OpenSans-Italic-webfont.eot new file mode 100644 index 0000000..0c8a0ae Binary files /dev/null and b/docs/fonts/OpenSans-Italic-webfont.eot differ diff --git a/docs/fonts/OpenSans-Italic-webfont.svg b/docs/fonts/OpenSans-Italic-webfont.svg new file mode 100644 index 0000000..e1075dc --- /dev/null +++ b/docs/fonts/OpenSans-Italic-webfont.svg @@ -0,0 +1,1830 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-Italic-webfont.woff b/docs/fonts/OpenSans-Italic-webfont.woff new file mode 100644 index 0000000..ff652e6 Binary files /dev/null and b/docs/fonts/OpenSans-Italic-webfont.woff differ diff --git a/docs/fonts/OpenSans-Light-webfont.eot b/docs/fonts/OpenSans-Light-webfont.eot new file mode 100644 index 0000000..1486840 Binary files /dev/null and b/docs/fonts/OpenSans-Light-webfont.eot differ diff --git a/docs/fonts/OpenSans-Light-webfont.svg b/docs/fonts/OpenSans-Light-webfont.svg new file mode 100644 index 0000000..11a472c --- /dev/null +++ b/docs/fonts/OpenSans-Light-webfont.svg @@ -0,0 +1,1831 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-Light-webfont.woff b/docs/fonts/OpenSans-Light-webfont.woff new file mode 100644 index 0000000..e786074 Binary files /dev/null and b/docs/fonts/OpenSans-Light-webfont.woff differ diff --git a/docs/fonts/OpenSans-LightItalic-webfont.eot b/docs/fonts/OpenSans-LightItalic-webfont.eot new file mode 100644 index 0000000..8f44592 Binary files /dev/null and b/docs/fonts/OpenSans-LightItalic-webfont.eot differ diff --git a/docs/fonts/OpenSans-LightItalic-webfont.svg b/docs/fonts/OpenSans-LightItalic-webfont.svg new file mode 100644 index 0000000..431d7e3 --- /dev/null +++ b/docs/fonts/OpenSans-LightItalic-webfont.svg @@ -0,0 +1,1835 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-LightItalic-webfont.woff b/docs/fonts/OpenSans-LightItalic-webfont.woff new file mode 100644 index 0000000..43e8b9e Binary files /dev/null and b/docs/fonts/OpenSans-LightItalic-webfont.woff differ diff --git a/docs/fonts/OpenSans-Regular-webfont.eot b/docs/fonts/OpenSans-Regular-webfont.eot new file mode 100644 index 0000000..6bbc3cf Binary files /dev/null and b/docs/fonts/OpenSans-Regular-webfont.eot differ diff --git a/docs/fonts/OpenSans-Regular-webfont.svg b/docs/fonts/OpenSans-Regular-webfont.svg new file mode 100644 index 0000000..25a3952 --- /dev/null +++ b/docs/fonts/OpenSans-Regular-webfont.svg @@ -0,0 +1,1831 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-Regular-webfont.woff b/docs/fonts/OpenSans-Regular-webfont.woff new file mode 100644 index 0000000..e231183 Binary files /dev/null and b/docs/fonts/OpenSans-Regular-webfont.woff differ diff --git a/docs/global.html b/docs/global.html new file mode 100644 index 0000000..cfd2e1e --- /dev/null +++ b/docs/global.html @@ -0,0 +1,217 @@ + + + + + Global - Documentation + + + + + + + + + + + + + + + + +
+ +

Global

+ + + + + + + +
+ +
+ +

+ +

+ + +
+ +
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + +
+ + + + + + + + + + + + + + +

Methods

+ + + + + + +

subscribe()

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ +
+ + + + + + + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..31ac895 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,294 @@ + + + + + Home - Documentation + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+

multivents

Build Status Coverage Dependencies DevDependencies

+

multivents is a small pub-sub library. It allows you to create event channels, send (asynchronous) events over those channels and subscribe to events.

+

Quick Start

If you want to get started quickly, here is a basic example of how to use multivents:

+
var Channel = require('multivents');
+
+var myChannel = new Channel();
+
+myChannel.on('greet', function (who) {
+    console.log('hello ' + who);
+});
+
+myChannel.emit('greet', 'world'); // 'hello world'

If that's all you wanted to know, great! It's probably more than 90% of what you need this library for. If not, you may read on to find out more.

+

Installation

There's not really anything to install. If you want to use multivents in your project, include multivents.js and use it like described below.

+

multivents supports both CommonJS-style environments as well as AMD. You can install it via npm:

+
npm install --save multivents

If you want to extend multivents to your needs you might want to run tests. In order to do this, you can clone this repository and run npm install and npm test. Tests are written with assert and run with mocha (gulp-mocha).

+

Terminology and Concept

This library implements so called message channels or event channels. A channel is a communication device that has events associated with it. When a message is sent over a message channel, all callback functions registered for that specific message will be executed.

+

The following documentation uses the terms event and message synonymously as well as event name and event type. Listening for an event or adding a callback is the process that registers a function to be executed when an event is emitted / triggered / fired i.e. a message is being sent.

+

How to use / API

Basic functions

Channel : This constructor function creates a new message channel. You can invoke the constructor without passing any arguments (using the new keyword if you want to) and a new channel object is created for you. You can also call Channel as a function and pass in an object, that you want to transform into a message channel. A third option would be to pass the constructor a string, which creates a named channel. You can read more on the semantics of named channels in the extra paragraph I dedicated them. A channel provides a handful of methods that are discussed below.

+

on: With this method you can register callbacks to be executed when a certain event is triggered. You have to pass in the event name and the callback function, but you can optionally provide a third argument. This third argument should be an object which is then used as the callback function's this (context injection). The fourth parameter of the on function is a boolean that gives a preference on whether the callback function shall be executed asynchronously. Note, however, that asynchronous execution is not guarenteed; read why in this paragraph.

+

function on ( /* String */ type, /* Function */ callback, /* Object */ context ?, /* boolean*/ async? )

+

attach: Alias for on.

+

once: When you want a callback to be only executed once, you can use the once method (which is to be used just like on).

+

function once ( /* String */ type, /* Function */ callback, /* Object */ context ?, /* boolean*/ async? )

+

off : Removes event listeners. Functions will no longer be invoked when the specified event is triggered. You can pass in the event name and a function reference to remove a specific function. If you just provide the first parameter, all callbacks for the given event type are removed. You can remove all event handlers from all events on this channel, by calling off without any arguments.

+

function off ( /* String */ type ?, /* Function */ callback ? )

+

detach: Alias for off.

+

emit: Calling this method triggers the specified event and will result in all registered callbacks being executed. All arguments that get passed to the emit are provided to the callback function as arguments.

+

function emit ( /* String */ type, ... )

+

trigger, fire: Aliases for emit

+

Those are the most important functions provided by multivents. If you want to get started now, skip on to the example code.

+

Silencing and locking

silence: This method prevents callbacks from being executed. You can use silence on different things depending on the arguments you provide. If you call it without any arguments, the whole message channel is silenced and emitting events on this channel won't work. If you call silence with one argument, you can specify an event that should no longer be emittable, while all other events on this channel will still work fine. If you call silence with two arguments, you can silence one specific callback function from executing. When the according event is triggered, all of its other callbacks are still being invoked, except the one you silenced.

+

function silence ( /* String */ type ?, /* Function */ funct ? )

+

unsilence: After having silenced an event channel or an event or a single callback function, you can unsilence it with unsilence. If you unsilence a single event, but the entire channel is still silenced, triggering the event will still have no effect.

+

function unsilence ( /* String */ type ?, /* Function */ funct ? )

+
+

Silencing and locking have similar semantics. They give you the flexibility to target an entire channel or a specific event. Their effects work top-down meaning that, if a channel is silenced but an event is not, you cannot trigger this event. Here, the channel' silencing/locking state is more important than the one of single events.

+
+

lock: Locking means preventing new callbacks from being registered. Similar to silencing, you can lock an entire channel and prohibiting any callbacks from being registered to it, you can also lock a single event. You can call lock with no arguments (locking the entire channel) or with a string argument, specifying the event you want to lock.

+

function lock ( /* String */ type ? )

+

unlock: Unlocking a channel or an event allows new callbacks to be attached to it. You can unlock a locked channel or just a single event by using the optional paramter.

+

function unlock ( /* String */ type ? )

+

reset: This method lets you remove all callbacks from an event or even all callbacks of all events on an entire channel. If you call this function without any arguments, you reset the whole channel. Note, that reset also unsilences and unlocks an event.

+

function reset ( /* String */ type ? )

+

Restricting

You can create a wrapper object for an event channel so that you can give limited access to that channel, allowing other parts of your code to only access certain methods of the channel. For instance you may not want to allow a module to silence or lock a channel, but you want it to be able to trigger events. For this you can use the restrict method.

+

restrict: You can pass in an array of methods you want to make accessible on the wrapper object.

+

function restrict ( /* String[] */ permissions ? )

+

Example Code

Basic usage

First, you want to include multivents in your project. If you are writing for nodejs, you would npm install multivents and then in your project:

+
var Channel = require('multivents');

Now we can use multivents, to create a message channel using the Channel constructor (here in conjunction with the new keyword).

+
var channel = new Channel();

The new channel provides the on method that allows you to specify an event name and a function that is meant to be executed in case the given event is triggered.

+
channel.on('ping', function () {
+    console.log('ping event fired!');
+});

Your function can also have parameters.

+
var greet = function (who) {
+    console.log('hello' + who);
+};
+channel.on('ping', greet);

You can trigger an event using the channel's emit method and optionally provide additional arguments that will be passed on to the callback.

+
channel.emit('ping', 'world');
+ // 'ping event fired!'
+ // 'hello world'

When you want to remove a callback function, you can detach it from the event by using the off message and specifying the event and the function you want to detach.

+
channel.off('ping', greet);

Now, when you fire the event again, the greet function will no longer be invoked.

+
channel.emit('event'); // 'ping event fired!'

Context injection

When registering a callback, you can specify the context in which the callback function will be executed.

+
var channel = new Channel();
+var bob = { name : 'Bob' };
+channel.on('greet', function () {
+    console.log('Hello, I\'m ' + this.name + '!');
+}, bob);
+channel.emit('greet'); // 'Hello, I'm Bob!'

The bob object is used as the callback's this as it was provided to the on call as the third argument.

+

Silencing and locking

Let's start again by creating a new event channel.

+
var channel = Channel({});

Remember that the Channel constructor can be passed an object to be transformed into a message channel. We now create two events and register callback functions to them.

+
channel.on('ping', function () {
+    console.log('ping event fired');
+});
+channel.on('pong', function () {
+    console.log('pong event fired');
+});

When a channel is silenced, none of its events can be triggered. Notice though, that multivents will not throw any exceptions.

+
channel.silence();
+channel.emit('ping'); // [nothing happens]
+channel.emit('pong'); // [nothing happens]

Let's now unsilence the channel and silence just the pong event.

+
channel.unsilence();
+channel.silence('pong');
+channel.emit('pong'); // [nothing happens]
+channel.emit('ping'); // 'ping event fired'

When a channel is silenced, you can still attach new event listeners. That's not the case, when the channel is locked.

+
channel.silence();
+channel.on('peng', function () {
+    console.log('peng event fired');
+});
+channel.unsilence();
+channel.emit('peng'); // 'peng event fired'
+channel.lock();
+channel.on('pung', function () {
+    console.log('pung event fire');
+});
+channel.emit('pung'); // [nothing happens]
+channel.emit('peng'); // 'peng event fired'

You can see, that attaching a new event listener when the channel was locked had no effect. You can also lock a single event.

+

Restricting

You can create restricted access to a channel using the restrict method:

+
var restrictedChannel = channel.restrict(['emit', 'on']);
+console.log(typeof restrictedChannel.emit); // 'function'
+console.log(typeof restrictedChannel.on); // 'function'
+console.log(typeof restrictedChannel.silence); // 'undefined'

The new object only provides the functions you chose in the restrict-call.

+

Asynchronous Callback Execution

By default, multivents calls event handler functions asynchronously.

+

In some cases you might want to declare a callback that is explicitly meant to be invoked synchronously. You can do that with a fourth argument in the on function.

+
channel.on('ping', f, null, false);

Above you can see a callback registration that declares the callback's preference to be executed synchronously.

+

You can also emit an event with a preference to have its callbacks be executed synchronously.

+
channel.emitSync('ping');

If neither the callback registration code nor the event emitter make any statement on how callback execution should be handled, multivents does it asynchronously. If one part (emit or on) states a preference and the other one doesn't, the preference will be respected. If both have the same preference, well, that's what we're doing. If there is a conflict, the emitter wins. So basically, if you use the emitSync or emitAsync method, the according execution style is guaranteed. E.g. in the following case:

+
channel.on('ping', f, null, false); // [`f` wants to be called synchronously]
+channel.emitAsync('ping'); // [`emitAsync` guarantees asynchronous execution]

the callback will be executed asynchronously, because the emitAsync method was used and is stronger than the async flag in the on call.

+

Named Event channels

When you call the Channel constructor and pass it a string value, you create a named channel or public channel (which are two terms for the same thing). Because it has a name, such an event channel is "public" and can be retrieved via its name. multivents contains a closure that keeps track of all named channels and allows you to retrieve them using the Channel constructor's get method.

+
Channel('myEventchannel');
+var b = Channel.get('myEventchannel'); // [b now contains an event channel]

Why? Well, unnamed channels have to be passed around in order to connect separate parts of an application. If you don't want to do that, you can use public channels.

+

Because every part of your application will have access to public channels, they and their events can not be silenced or locked.

+

License

The MIT License (MIT)

+

Copyright © 2014-2017 Peter Steinberg

+

Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions:

+

The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+
+ + + + + + + + + +
+ +
+ +

+ multivents.js +

+ + +
+ +
+
+ + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + +
Author:
+
+ +
+ + + + + + + + + + + + + +
+ + + + + +
This is the only source file of multivents. It includes all the functionality and API.
+ + + + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ +
+ + + + + + + \ No newline at end of file diff --git a/docs/module-Channel.html b/docs/module-Channel.html new file mode 100644 index 0000000..7c4e9a2 --- /dev/null +++ b/docs/module-Channel.html @@ -0,0 +1,2846 @@ + + + + + Channel - Documentation + + + + + + + + + + + + + + + + +
+ +

Channel

+ + + + + + + +
+ +
+ + + + + +
+ +
+
+ + +
The Channel class.
+ + + + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +

Members

+ + + +

(inner) events

+ + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ The `events` variable saves the names of registered events and associates those names with arrays of callback functions to be called, when the event is triggered. +
+ + + + + + + + + + + + +

Methods

+ + + + + + +

(inner) ChannelConstructor(targetopt)

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ Calling the `Channel` function creates a new message channel over which messages can be sent. The function adds methods to an object that allow for listening to and triggering events. You can pass in an object to transform it into a message channel or a string to create a public named channel. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
target + + +Object + + + + + + <optional>
+ + + + + + 		An object that is to be transormed into an event channel. If no object is given, a new one is being created.
+ + + + + + + + + + + + + + + + + + + + + +

(inner) emit(type) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ Casdsadasdasdalling this method triggers the specified event and will result in all registered callbacks being executed. +You should no rely on the order in which the callbacks are being invoked. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +String + + + + The name of the event to be triggered. Any additional arguments will be passed to + the callback function.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

(inner) emitAsync(type) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ This method works like `emit` but guarantees asynchronous execution of all callbacks for this event. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +String + + + + The name of the event to be triggered. Any additional arguments will be passed to + the callback function.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

(inner) emitSync(type) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ This method works like `emit` but guarantees synchronous execution of all callbacks for this event. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +String + + + + The name of the event to be triggered. Any additional arguments will be passed to + the callback function.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

(inner) isLocked(typeopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ Returns whether the channel or an event type is locked. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +String + + + + + + <optional>
+ + + + + + 		Optional: The name of the event whose status is being requested. + If no event type is specified, the whole channel's status will be returned.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

(inner) isSilenced(typeopt, funcopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ Returns whether the channel or an event type or a specific callback is silenced. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +String + + + + + + <optional>
+ + + + + + 		Optional: The name of the event whose status is being requested. + If no event type is specified, the whole channel's status will be returned.
func + + +function + + + + + + <optional>
+ + + + + + 		Optional: The function whose status is being requested. + If no function is specified the whole event type's status will be returned.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

(inner) lock(typeopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ `Lock` prevents new callbacks from being added. Affects the entire channel or specific events. +Does not affect public channels at all. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +String + + + + + + <optional>
+ + + + + + 		Optional: The name of the event to which no new callbacks shall be registerd. + If no event name is specified, the whole channel will be locked.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

(inner) off(typeopt, funcopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ This method allows it to remove event listeners. If a reference to a function is given, +only that function is removed. If only the type is given, all callbacks are removed from that event. +If no arguments are passed, all callbacks on all events are removed. +On public channels, only the first option (with both a type and a function reference) is permitted. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +String + + + + + + <optional>
+ + + + + + 		Optional: The event name of the callbacks to be removed.
func + + +function + + + + + + <optional>
+ + + + + + 		Optional: The callback function to be removed.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

(inner) on(type, func, ctxopt, asyncopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ With this method you can register callbacks to be executed when a certain event is triggered. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +String + + + + + + + + + + The name of the event is specified by a string. It doesn't matter, + whether this event name already exists or not.
func + + +function + + + + + + + + + + The function to be called, when the event is triggered.
ctx + + +Object + + + + + + <optional>
+ + + + + + 		Optionally, you can provide a context for the callback function.
async + + +boolean + + + + + + <optional>
+ + + + + + 		A preference regarding whether this callback shall the executed asynchronously. + (Not a guarantee!)
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

(inner) once(type, func, ctxopt, asyncopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ This method does the same as `on` but it registers a callback that will only be executed once. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +String + + + + + + + + + + The name of the event is specified by a string. It doesn't matter, whether this event name already exists or not.
func + + +function + + + + + + + + + + The function to be called, when the event is triggered.
ctx + + +Object + + + + + + <optional>
+ + + + + + 		Optionally, you can provide a context for the callback function.
async + + +boolean + + + + + + <optional>
+ + + + + + 		A preference regarding whether this callback shall the executed + asynchronously. (Not a guarantee!)
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

(inner) reset(typeopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ This lets you remove all event listeners from the message channel or from a specified event type. +(Also sets `silenced` and `locked` to `false`). +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +String + + + + + + <optional>
+ + + + + + 		Optional: The name of the event whose callbacks shall be removed. + If no event type is given, the whole channel will be reset.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

(inner) silence(Optional:, Optional:) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ The `silence` method prevents any new messages from being sent over the message channel. +Affects the entire channel or specific events or even specific callbacks. +Does not affect public channels at all. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
Optional: + + +String + + + + The name of the event that is meant to be silenced. + If no event type is specified, the whole channel will be silenced.
Optional: + + +function + + + + The function that is no longer to be executed when the event is triggered. + If no function is specified the whole event type will be silenced.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

(inner) unlock(typeopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ Unlock allows callbacks from being added to a channel after it was locked. + +This method does not check if the channel is public, because if it were, it could not +have been locked in the first place. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +String + + + + + + <optional>
+ + + + + + 		Optional: The name of the event that shall accept new callbacks again.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + +

(inner) unsilence(typeopt, funcopt) → {Object}

+ + + + + + +
+ + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ With this method you can enable message sending after it was disable using `silence`. + +This method does not check if the channel is public, because if it were, it could not +have been silenced in the first place. +
+ + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +String + + + + + + <optional>
+ + + + + + 		Optional: The name of the event that is meant to be unsilenced.
func + + +function + + + + + + <optional>
+ + + + + + 		Optional: The function that shall be executed again, after being silenced.
+ + + + + + + + + + + + + + +
Returns:
+ + +
+ The channel object. Or rather: 'this'. So be careful with rebinding 'this'. +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + + +
+ +
+ + + + +
+ +
+ + + + + + + \ No newline at end of file diff --git a/docs/multivents.js.html b/docs/multivents.js.html new file mode 100644 index 0000000..c30bbde --- /dev/null +++ b/docs/multivents.js.html @@ -0,0 +1,621 @@ + + + + + multivents.js - Documentation + + + + + + + + + + + + + + + + +
+ +

multivents.js

+ + + + + + + +
+
+ 
/* global module,setTimeout */
+
+/**
+ * @author Peter Steinberg <objectliteral@outlook.com>
+ * @summary Multifunctional Event System
+ * @fileOverview This is the only source file of multivents. It includes all the functionality and API.
+ */
+
+var Channel;
+
+/**
+ * Calling the `Channel` function creates a new message channel over which messages can be sent. The function adds methods to an object that allow for listening to and triggering events. You can pass in an object to transform it into a message channel or a string to create a public named channel.
+ *
+ * @param {Object} [target] An object that is to be transormed into an event channel. If no object is given, a new one is being created.
+ * @exports Channel
+ * @constructor
+ */
+Channel = (function () {
+
+    'use strict';
+
+    var ChannelConstructor,
+        channels;
+
+    channels = { };
+
+    /**
+     * @alias Channel
+     */
+    ChannelConstructor = function ChannelConstructor (target) { // eslint-disable-line no-shadow
+
+        var addEvent,
+            channel,
+            emit,
+            events,
+            isPublic,
+            locked,
+            silenced;
+
+        locked = silenced = false;
+
+        addEvent = function (eventName, override) {
+
+            if (typeof events[eventName] === "undefined" || override) {
+                events[eventName] = {
+                    "callbacks": [],
+                    "silenced": false,
+                    "locked": false
+                };
+            }
+
+            return events[eventName];
+
+        };
+
+        /**
+         * The `events` variable saves the names of registered events and associates those names with arrays of callback functions to be called, when the event is triggered.
+         * 
+         * @member
+         */
+        events = {};
+
+        isPublic = typeof target === 'string';
+
+        if (isPublic) {
+            channels[target] = {};
+            channel = channels[target];
+        } else if (typeof target === 'object') {
+            channel = target;
+        } else {
+            channel = this || {};
+        }
+
+        emit = function emit (type, data, async) { // eslint-disable-line no-shadow
+
+            var asyncEvt,
+                asyncScore,
+                callback,
+                index,
+                len,
+                list;
+
+            if (silenced || (events[type] && events[type].silenced)) {
+                return channel;
+            }
+
+            list = (events[type] && events[type].callbacks) || [];
+            len = list.length;
+            index = 0;
+
+            asyncEvt = async === false ? -1 : async || 0;
+
+            for (; index < len; index = index + 1) {
+                callback = list[index];
+                if (!callback.silenced) {
+                    asyncScore = callback.async + asyncEvt;
+                    if ((callback.async === 0 && asyncEvt === 0) || asyncScore > 0 || asyncEvt === 1) {
+
+                        setTimeout(
+
+                            function () {
+
+                                this.func.apply(this.context,
+                                    this.data.concat([ this ])
+                                );
+
+                            }.bind({
+                                "func": callback.callbackFunction,
+                                "context": callback.context,
+                                "name": type,
+                                "channel": channel,
+                                "async": true,
+                                "data": data
+                            }),
+
+                        0);
+
+                    } else if (asyncScore < 0 || asyncEvt === -1) {
+                        list[index].callbackFunction.apply(list[index].context,
+                            data.concat([ {
+                                "func": callback.callbackFunction,
+                                "context": callback.context,
+                                "name": type,
+                                "channel": channel,
+                                "async": false,
+                                "data": data
+                            } ])
+                        );
+                    }
+                }
+            }
+
+            return channel;
+
+        };
+
+        Object.assign(channel, /** @lends Channel# */{
+
+             /**
+             * With this method you can register callbacks to be executed when a certain event is triggered.
+             *
+             * @param {String} type The name of the event is specified by a string. It doesn't matter,
+             *                 whether this event name already exists or not.
+             * @param {Function} func The function to be called, when the event is triggered.
+             * @param {Object} [ctx] Optionally, you can provide a context for the callback function.
+             * @param {boolean} [async] A preference regarding whether this callback shall the executed asynchronously.
+             *                  (Not a guarantee!)
+             * @returns {Object} The channel object. Or rather: 'this'. So be careful with rebinding 'this'.
+             */
+            "on": function on (type, func, ctx, async) { // eslint-disable-line id-length
+
+                if (locked || (events[type] && events[type].locked)) {
+                    return this;
+                }
+
+                addEvent(type).callbacks.push({
+                    "callbackFunction": func,
+                    "context": ctx,
+                    "silenced": false,
+                    "async": async === false ? -1 : async || 0
+                });
+
+                return this;
+
+            },
+
+            /**
+             * This method does the same as `on` but it registers a callback that will only be executed once.
+             *
+             * @param {String} type The name of the event is specified by a string. It doesn't matter,  whether this event name already exists or not.
+             * @param {Function} func The function to be called, when the event is triggered.
+             * @param {Object} [ctx] Optionally, you can provide a context for the callback function.
+             * @param {boolean} [async] A preference regarding whether this callback shall the executed
+             *                  asynchronously. (Not a guarantee!)
+             * @returns {Object} The channel object. Or rather: 'this'. So be careful with rebinding 'this'.
+             */
+            "once": function once (type, func, ctx, async) {
+
+                var callbackFunction,
+                    called;
+
+                called = false;
+
+                callbackFunction = function () {
+                    if (!called) {
+                        // I explicitly want to say, that disabling this rule is fine here, because I am sure, that the correct binding of 'this' gets taken care of!
+                        func.apply(this, [].slice.call(arguments)); // eslint-disable-line no-invalid-this
+                        channel.off(type, callbackFunction);
+                        called = true;
+                    }
+                };
+
+                this.on(type, callbackFunction, ctx, async);
+
+                return this;
+
+            },
+
+            /**
+             * This method allows it to remove event listeners. If a reference to a function is given,
+             * only that function is removed. If only the type is given, all callbacks are removed from that event.
+             * If no arguments are passed, all callbacks on all events are removed.
+             * On public channels, only the first option (with both a type and a function reference) is permitted.
+             *
+             * @param {String} [type] Optional: The event name of the callbacks to be removed.
+             * @param {Function} [func] Optional: The callback function to be removed.
+             * @returns {Object} The channel object. Or rather: 'this'. So be careful with rebinding 'this'.
+             */
+            "off": function off (type, func) {
+
+                var index,
+                    typeIndex;
+
+                if (locked === true) {
+                    return this;
+                }
+
+                if (isPublic === false) {
+                    if (typeof type === "undefined") {
+                        for (typeIndex in events) {
+                            if (events.hasOwnProperty(typeIndex)) {
+                                events[typeIndex].callbacks = [];
+                            }
+                        }
+                    } else if (events[type] && events[type].locked === false) {
+                        if (typeof func === "undefined") {
+                            events[type].callbacks = [];
+                        } else {
+                            for (index = 0; index < events[type].callbacks.length; index = index + 1) {
+                                events[type].callbacks.splice(index, 1);
+                            }
+                        }
+                    }
+
+                    return this;
+
+                }
+
+                if (typeof type !== "undefined" && events[type] && typeof func !== "undefined") {
+                    for (index = 0; index < events[type].callbacks.length; index = index + 1) {
+                        if (events[type].callbacks[index].callbackFunction === func) {
+                            events[type].callbacks.splice(index, 1);
+                        }
+                    }
+                }
+
+                return this;
+
+            },
+
+            /**
+             * Calling this method triggers the specified event and will result in all registered callbacks being executed.
+             * You should no rely on the order in which the callbacks are being invoked.
+             *
+             * @param {String} type The name of the event to be triggered. Any additional arguments will be passed to
+             *                 the callback function.
+             * @returns {Object} The channel object. Or rather: 'this'. So be careful with rebinding 'this'.
+             */
+            "emit": function (type) {
+                return emit.call(this, type, Array.prototype.slice.call(arguments, 1));
+            },
+
+            /**
+             * This method works like `emit` but guarantees synchronous execution of all callbacks for this event.
+             *
+             * @param {String} type The name of the event to be triggered. Any additional arguments will be passed to
+             *                 the callback function.
+             * @returns {Object} The channel object. Or rather: 'this'. So be careful with rebinding 'this'.
+             */
+            "emitSync": function (type) {
+                return emit.call(this, type, Array.prototype.slice.call(arguments, 1), false);
+            },
+
+            /**
+             * This method works like `emit` but guarantees asynchronous execution of all callbacks for this event.
+             *
+             * @param {String} type The name of the event to be triggered. Any additional arguments will be passed to
+             *                 the callback function.
+             * @returns {Object} The channel object. Or rather: 'this'. So be careful with rebinding 'this'.
+             */
+            "emitAsync": function (type) {
+                return emit.call(this, type, Array.prototype.slice.call(arguments, 1), true);
+            },
+
+            /**
+             * The `silence` method prevents any new messages from being sent over the message channel.
+             * Affects the entire channel or specific events or even specific callbacks.
+             * Does not affect public channels at all.
+             *
+             * @method
+             * @param {String} Optional: The name of the event that is meant to be silenced.
+             *                 If no event type is specified, the whole channel will be silenced.
+             * @param {Function} Optional: The function that is no longer to be executed when the event is triggered.
+             *                   If no function is specified the whole event type will be silenced.
+             * @returns {Object} The channel object. Or rather: 'this'. So be careful with rebinding 'this'.
+             */
+            "silence": (function () {
+
+                if (isPublic === true) {
+                    return function () {
+                        return this;
+                    };
+                } else {
+                    return function silence (type, func) {
+
+                        var callbackCount,
+                            evt,
+                            index;
+
+                        if (typeof type === "undefined") {
+                            silenced = true;
+
+                            return this;
+                        }
+
+                        if (typeof func === "undefined") {
+                            addEvent(type).silenced = true;
+
+                            return this;
+                        }
+
+                        evt = events[type];
+
+                        if (typeof evt !== "undefined") {
+                            callbackCount = evt.callbacks.length;
+                            for (index = 0; index < callbackCount; index = index + 1) {
+                                if (evt.callbacks[index].callbackFunction === func) {
+                                    evt.callbacks[index].silenced = true;
+                                }
+                            }
+                        }
+
+                        return this;
+
+                    };
+                }
+
+            }()),
+
+            /**
+             * With this method you can enable message sending after it was disable using `silence`.
+             *
+             * This method does not check if the channel is public, because if it were, it could not
+             * have been silenced in the first place.
+             *
+             * @param {String} [type] Optional: The name of the event that is meant to be unsilenced.
+             * @param {Function} [func] Optional: The function that shall be executed again, after being silenced.
+             * @returns {Object} The channel object. Or rather: 'this'. So be careful with rebinding 'this'.
+             */
+            "unsilence": function unsilence (type, func) {
+
+                var callbackCount,
+                    evt,
+                    index;
+
+                if (typeof type === "undefined") {
+                    silenced = false;
+
+                    return this;
+                }
+
+                if (typeof func === "undefined") {
+                    addEvent(type).silenced = false;
+                    
+                    return this;
+                }
+
+                evt = events[type];
+
+                if (typeof evt !== "undefined") {
+                    callbackCount = evt.callbacks.length;
+                    for (index = 0; index < callbackCount; index = index + 1) {
+                        if (evt.callbacks[index].callbackFunction === func) {
+                            evt.callbacks[index].silenced = false;
+                        }
+                    }
+                }
+
+                return this;
+
+            },
+
+            /**
+             * `Lock` prevents new callbacks from being added. Affects the entire channel or specific events.
+             * Does not affect public channels at all.
+             *
+             * @method
+             * @param {String} [type] Optional: The name of the event to which no new callbacks shall be registerd.
+             *                 If no event name is specified, the whole channel will be locked.
+             * @returns {Object} The channel object. Or rather: 'this'. So be careful with rebinding 'this'.
+             */
+            "lock": (function () {
+                
+                if (isPublic === true) {
+                    return function () {
+                        return this;
+                    };
+                } else {
+                    return function lock (type) {
+
+                        if (typeof type === "undefined") {
+                            locked = true;
+                        } else {
+                            addEvent(type).locked = true;
+                        }
+
+                        return this;
+
+                    };
+                }
+
+            }()),
+
+            /**
+             * Unlock allows callbacks from being added to a channel after it was locked.
+             *
+             * This method does not check if the channel is public, because if it were, it could not
+             * have been locked in the first place.
+             *
+             * @param {String} [type] Optional: The name of the event that shall accept new callbacks again.
+             * @returns {Object} The channel object. Or rather: 'this'. So be careful with rebinding 'this'.
+             */
+            "unlock": function unlock (type) {
+
+                if (typeof type === "undefined") {
+                    locked = false;
+                } else {
+                    addEvent(type).locked = false;
+                }
+
+                return this;
+
+            },
+
+            /**
+             * This lets you remove all event listeners from the message channel or from a specified event type.
+             * (Also sets `silenced` and `locked` to `false`).
+             *
+             * @method
+             * @param {String} [type] Optional: The name of the event whose callbacks shall be removed.
+             *                 If no event type is given, the whole channel will be reset.
+             * @returns {Object} The channel object. Or rather: 'this'. So be careful with rebinding 'this'.
+             */
+            "reset": (function () {
+                
+                if (isPublic === true) {
+                    return function () {
+                        return this;
+                    };
+                } else {
+                    return function reset (type) {
+                        
+                        if (events !== null) {
+                            if (typeof type === "undefined") {
+                                events = { };
+                            } else {
+                                addEvent(type, true);
+                            }
+                        }
+
+                        return this;
+                        
+                    };
+                }
+
+            }()),
+
+            /**
+             * Returns whether the channel or an event type or a specific callback is silenced.
+             *
+             * @param {String} [type] Optional: The name of the event whose status is being requested.
+             *                 If no event type is specified, the whole channel's status will be returned.
+             * @param {Function} [func] Optional: The function whose status is being requested.
+             *                   If no function is specified the whole event type's status will be returned.
+             * @returns {Object} The channel object. Or rather: 'this'. So be careful with rebinding 'this'.
+             */
+            "isSilenced": function isSilenced (type, func) {
+                
+                return isPublic === false && (function () {
+
+                    var callbackCount,
+                        channelSilenced,
+                        evt,
+                        index;
+
+                    channelSilenced = false;
+
+                    if (typeof type === "undefined" || silenced) {
+                        channelSilenced = silenced;
+                    } else if (events[type] && (typeof func === "undefined" || events[type].silenced)) {
+                        channelSilenced = events[type].silenced;
+                    } else {
+                        evt = events[type];
+                        if (typeof evt !== "undefined") {
+                            callbackCount = evt.callbacks.length;
+                            for (index = 0; index < callbackCount; index = index + 1) {
+                                if (evt.callbacks[index].callbackFunction === func) {
+                                    channelSilenced = evt.callbacks[index].silenced;
+                                    break;
+                                }
+                            }
+                        }
+                    }
+
+                    return channelSilenced;
+
+                }());
+
+            },
+
+            /**
+             * Returns whether the channel or a specifc event type on this channel is locked.
+             *
+             * @param {String} [type] Optional: The name of the event whose status is being requested. If no event type is specified, the whole channel's status will be returned.
+             * @returns {Object} The channel object. Or rather: 'this'. So be careful with rebinding 'this'.
+             */
+            "isLocked": function isLocked (type) {
+                
+                return isPublic === false && (function () {
+
+                    var channelLocked;
+
+                    if (typeof type === "undefined" || locked) {
+                        channelLocked = locked;
+                    } else {
+                        channelLocked = (events[type] || false) && events[type].locked;
+                    }
+
+                    return channelLocked;
+
+                }());
+
+            }
+
+        });
+
+        /*
+         * These aliases get added to give you the best expressability.
+         * You can currently only delete them by creating a new channel and `delete channel.subscribe` etc.
+         */
+        channel.subscribe = channel.attach = channel.on;
+        channel.unsubscribe = channel.detach = channel.off;
+        channel.publish = channel.fire = channel.trigger = channel.emit;
+        channel.publishSync = channel.fireSync = channel.triggerSync = channel.emitSync;
+        channel.publishAsync = channel.fireAsync = channel.triggerAsync = channel.emitAsync;
+
+        return channel;
+
+    };
+
+    /**
+     * This method returns a named channel.
+     *
+     * @param {String} The name of the public channel you want to retrieve.
+     * @returns The public channel with the specified name
+     */
+    ChannelConstructor.get = function (name) {
+        return channels[name];
+    };
+
+    return ChannelConstructor;
+
+}());
+
+
+
+ + + + +
+ +
+ + + + + + + diff --git a/docs/scripts/linenumber.js b/docs/scripts/linenumber.js new file mode 100644 index 0000000..9cb8914 --- /dev/null +++ b/docs/scripts/linenumber.js @@ -0,0 +1,25 @@ +/*global document */ +(function() { + var source = document.getElementsByClassName('prettyprint source linenums'); + var i = 0; + var lineNumber = 0; + var lineId; + var lines; + var totalLines; + var anchorHash; + + if (source && source[0]) { + anchorHash = document.location.hash.substring(1); + lines = source[0].getElementsByTagName('li'); + totalLines = lines.length; + + for (; i < totalLines; i++) { + lineNumber++; + lineId = 'line' + lineNumber; + lines[i].id = lineId; + if (lineId === anchorHash) { + lines[i].className += ' selected'; + } + } + } +})(); diff --git a/docs/scripts/prettify/Apache-License-2.0.txt b/docs/scripts/prettify/Apache-License-2.0.txt new file mode 100644 index 0000000..75b5248 --- /dev/null +++ b/docs/scripts/prettify/Apache-License-2.0.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/docs/scripts/prettify/lang-css.js b/docs/scripts/prettify/lang-css.js new file mode 100644 index 0000000..bb6dbea --- /dev/null +++ b/docs/scripts/prettify/lang-css.js @@ -0,0 +1,2 @@ +PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n "]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com", +/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]); diff --git a/docs/scripts/prettify/prettify.js b/docs/scripts/prettify/prettify.js new file mode 100644 index 0000000..ec2a488 --- /dev/null +++ b/docs/scripts/prettify/prettify.js @@ -0,0 +1,28 @@ +var q=null;window.PR_SHOULD_USE_CONTINUATION=!0; +(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a= +[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;ci[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m), +l=[],p={},d=0,g=e.length;d=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/, +q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/, +q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g, +"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a), +a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e} +for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"], +"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"], +H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"], +J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+ +I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]), +["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css", +/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}), +["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes", +hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p=0){var k=k.match(g),f,b;if(b= +!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p th:last-child { border-right: 1px solid #ddd; } + +.ancestors { color: #999; } +.ancestors a +{ + color: #999 !important; + text-decoration: none; +} + +.clear +{ + clear: both; +} + +.important +{ + font-weight: bold; + color: #950B02; +} + +.yes-def { + text-indent: -1000px; +} + +.type-signature { + color: #aaa; +} + +.name, .signature { + font-family: Consolas, Monaco, 'Andale Mono', monospace; +} + +.details { margin-top: 14px; border-left: 2px solid #DDD; } +.details dt { width: 120px; float: left; padding-left: 10px; padding-top: 6px; } +.details dd { margin-left: 70px; } +.details ul { margin: 0; } +.details ul { list-style-type: none; } +.details li { margin-left: 30px; padding-top: 6px; } +.details pre.prettyprint { margin: 0 } +.details .object-value { padding-top: 0; } + +.description { + margin-bottom: 1em; + margin-top: 1em; +} + +.code-caption +{ + font-style: italic; + font-size: 107%; + margin: 0; +} + +.prettyprint +{ + border: 1px solid #ddd; + width: 80%; + overflow: auto; +} + +.prettyprint.source { + width: inherit; +} + +.prettyprint code +{ + font-size: 100%; + line-height: 18px; + display: block; + padding: 4px 12px; + margin: 0; + background-color: #fff; + color: #4D4E53; +} + +.prettyprint code span.line +{ + display: inline-block; +} + +.prettyprint.linenums +{ + padding-left: 70px; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.prettyprint.linenums ol +{ + padding-left: 0; +} + +.prettyprint.linenums li +{ + border-left: 3px #ddd solid; +} + +.prettyprint.linenums li.selected, +.prettyprint.linenums li.selected * +{ + background-color: lightyellow; +} + +.prettyprint.linenums li * +{ + -webkit-user-select: text; + -moz-user-select: text; + -ms-user-select: text; + user-select: text; +} + +.params .name, .props .name, .name code { + color: #4D4E53; + font-family: Consolas, Monaco, 'Andale Mono', monospace; + font-size: 100%; +} + +.params td.description > p:first-child, +.props td.description > p:first-child +{ + margin-top: 0; + padding-top: 0; +} + +.params td.description > p:last-child, +.props td.description > p:last-child +{ + margin-bottom: 0; + padding-bottom: 0; +} + +.disabled { + color: #454545; +} diff --git a/docs/styles/jsdoc.css b/docs/styles/jsdoc.css new file mode 100644 index 0000000..c13c7d4 --- /dev/null +++ b/docs/styles/jsdoc.css @@ -0,0 +1,645 @@ +@import url(https://fonts.googleapis.com/css?family=Montserrat:400,700); + +* { + box-sizing: border-box +} + +html, body { + height: 100%; + width: 100%; +} + +body { + color: #4d4e53; + background-color: white; + margin: 0 auto; + padding: 0 20px; + font-family: 'Helvetica Neue', Helvetica, sans-serif; + font-size: 16px; + line-height: 160%; +} + +a, +a:active { + color: #606; + text-decoration: none; +} + +a:hover { + text-decoration: none; +} + +article a { + border-bottom: 1px solid #ddd; +} + +article a:hover, article a:active { + border-bottom-color: #222; +} + +p, ul, ol, blockquote { + margin-bottom: 1em; +} + +h1, h2, h3, h4, h5, h6 { + font-family: 'Montserrat', sans-serif; +} + +h1, h2, h3, h4, h5, h6 { + color: #000; + font-weight: 400; + margin: 0; +} + +h1 { + font-weight: 300; + font-size: 48px; + margin: 1em 0 .5em; +} + +h1.page-title { + font-size: 48px; + margin: 1em 30px; +} + +h2 { + font-size: 24px; + margin: 1.5em 0 .3em; +} + +h3 { + font-size: 24px; + margin: 1.2em 0 .3em; +} + +h4 { + font-size: 18px; + margin: 1em 0 .2em; + color: #4d4e53; +} + +h4.name { + color: #fff; + background: #6d426d; + box-shadow: 0 .25em .5em #d3d3d3; + border-top: 1px solid #d3d3d3; + border-bottom: 1px solid #d3d3d3; + margin: 1.5em 0 0.5em; + padding: .75em 0 .75em 10px; +} + +h4.name a { + color: #fc83ff; +} + +h4.name a:hover { + border-bottom-color: #fc83ff; +} + +h5, .container-overview .subsection-title { + font-size: 120%; + letter-spacing: -0.01em; + margin: 8px 0 3px 0; +} + +h6 { + font-size: 100%; + letter-spacing: -0.01em; + margin: 6px 0 3px 0; + font-style: italic; +} + +tt, code, kbd, samp { + font-family: Consolas, Monaco, 'Andale Mono', monospace; + background: #f4f4f4; + padding: 1px 5px; +} + +.class-description { + font-size: 130%; + line-height: 140%; + margin-bottom: 1em; + margin-top: 1em; +} + +.class-description:empty { + margin: 0 +} + +#main { + float: right; + min-width: 360px; + width: calc(100% - 240px); +} + +header { + display: block +} + +section { + display: block; + background-color: #fff; + padding: 0 0 0 30px; +} + +.variation { + display: none +} + +.signature-attributes { + font-size: 60%; + color: #eee; + font-style: italic; + font-weight: lighter; +} + +nav { + float: left; + display: block; + width: 250px; + background: #fff; + overflow: auto; + position: fixed; + height: 100%; +} + +nav h3 { + margin-top: 12px; + font-size: 13px; + text-transform: uppercase; + letter-spacing: 1px; + font-weight: 700; + line-height: 24px; + margin: 15px 0 10px; + padding: 0; + color: #000; +} + +nav ul { + font-family: 'Lucida Grande', 'Lucida Sans Unicode', arial, sans-serif; + font-size: 100%; + line-height: 17px; + padding: 0; + margin: 0; + list-style-type: none; +} + +nav ul a, +nav ul a:active { + font-family: 'Montserrat', sans-serif; + line-height: 18px; + padding: 0; + display: block; + font-size: 12px; +} + +nav a:hover, +nav a:active { + color: #606; +} + +nav > ul { + padding: 0 10px; +} + +nav > ul > li > a { + color: #606; +} + +nav ul ul { + margin-bottom: 10px +} + +nav ul ul + ul { + margin-top: -10px; +} + +nav ul ul a { + color: hsl(207, 1%, 60%); + border-left: 1px solid hsl(207, 10%, 86%); +} + +nav ul ul a, +nav ul ul a:active { + padding-left: 20px +} + +nav h2 { + font-size: 12px; + margin: 0; + padding: 0; +} + +nav > h2 > a { + display: block; + margin: 10px 0 -10px; + color: #606 !important; +} + +footer { + color: hsl(0, 0%, 28%); + margin-left: 250px; + display: block; + padding: 15px; + font-style: italic; + font-size: 90%; +} + +.ancestors { + color: #999 +} + +.ancestors a { + color: #999 !important; +} + +.clear { + clear: both +} + +.important { + font-weight: bold; + color: #950B02; +} + +.yes-def { + text-indent: -1000px +} + +.type-signature { + color: #CA79CA +} + +.type-signature:last-child { + color: #eee; +} + +.name, .signature { + font-family: Consolas, Monaco, 'Andale Mono', monospace +} + +.signature { + color: #fc83ff; +} + +.details { + margin-top: 6px; + border-left: 2px solid #DDD; + line-height: 20px; + font-size: 14px; +} + +.details dt { + width: 120px; + float: left; + padding-left: 10px; +} + +.details dd { + margin-left: 70px; + margin-top: 6px; + margin-bottom: 6px; +} + +.details ul { + margin: 0 +} + +.details ul { + list-style-type: none +} + +.details pre.prettyprint { + margin: 0 +} + +.details .object-value { + padding-top: 0 +} + +.description { + margin-bottom: 1em; + margin-top: 1em; +} + +.code-caption { + font-style: italic; + font-size: 107%; + margin: 0; +} + +.prettyprint { + font-size: 14px; + overflow: auto; +} + +.prettyprint.source { + width: inherit; + line-height: 18px; + display: block; + background-color: #0d152a; + color: #aeaeae; +} + +.prettyprint code { + line-height: 18px; + display: block; + background-color: #0d152a; + color: #4D4E53; +} + +.prettyprint > code { + padding: 15px; +} + +.prettyprint .linenums code { + padding: 0 15px +} + +.prettyprint .linenums li:first-of-type code { + padding-top: 15px +} + +.prettyprint code span.line { + display: inline-block +} + +.prettyprint.linenums { + padding-left: 70px; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.prettyprint.linenums ol { + padding-left: 0 +} + +.prettyprint.linenums li { + border-left: 3px #34446B solid; +} + +.prettyprint.linenums li.selected, .prettyprint.linenums li.selected * { + background-color: #34446B; +} + +.prettyprint.linenums li * { + -webkit-user-select: text; + -moz-user-select: text; + -ms-user-select: text; + user-select: text; +} + +.params, .props { + border-spacing: 0; + border: 1px solid #ddd; + border-collapse: collapse; + border-radius: 3px; + box-shadow: 0 1px 3px rgba(0,0,0,0.1); + width: 100%; + font-size: 14px; + margin: 1em 0; +} + +.params .type { + white-space: nowrap; +} + +.params code { + white-space: pre; +} + +.params td, .params .name, .props .name, .name code { + color: #4D4E53; + font-family: Consolas, Monaco, 'Andale Mono', monospace; + font-size: 100%; +} + +.params td, .params th, .props td, .props th { + margin: 0px; + text-align: left; + vertical-align: top; + padding: 10px; + display: table-cell; +} + +.params td { + border-top: 1px solid #eee +} + +.params thead tr, .props thead tr { + background-color: #fff; + font-weight: bold; +} + +.params .params thead tr, .props .props thead tr { + background-color: #fff; + font-weight: bold; +} + +.params td.description > p:first-child, .props td.description > p:first-child { + margin-top: 0; + padding-top: 0; +} + +.params td.description > p:last-child, .props td.description > p:last-child { + margin-bottom: 0; + padding-bottom: 0; +} + +span.param-type, .params td .param-type, .param-type dd { + color: #606; + font-family: Consolas, Monaco, 'Andale Mono', monospace +} + +.param-type dt, .param-type dd { + display: inline-block +} + +.param-type { + margin: 14px 0; +} + +.disabled { + color: #454545 +} + +/* navicon button */ +.navicon-button { + display: none; + position: relative; + padding: 2.0625rem 1.5rem; + transition: 0.25s; + cursor: pointer; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + opacity: .8; +} +.navicon-button .navicon:before, .navicon-button .navicon:after { + transition: 0.25s; +} +.navicon-button:hover { + transition: 0.5s; + opacity: 1; +} +.navicon-button:hover .navicon:before, .navicon-button:hover .navicon:after { + transition: 0.25s; +} +.navicon-button:hover .navicon:before { + top: .825rem; +} +.navicon-button:hover .navicon:after { + top: -.825rem; +} + +/* navicon */ +.navicon { + position: relative; + width: 2.5em; + height: .3125rem; + background: #000; + transition: 0.3s; + border-radius: 2.5rem; +} +.navicon:before, .navicon:after { + display: block; + content: ""; + height: .3125rem; + width: 2.5rem; + background: #000; + position: absolute; + z-index: -1; + transition: 0.3s 0.25s; + border-radius: 1rem; +} +.navicon:before { + top: .625rem; +} +.navicon:after { + top: -.625rem; +} + +/* open */ +.nav-trigger:checked + label:not(.steps) .navicon:before, +.nav-trigger:checked + label:not(.steps) .navicon:after { + top: 0 !important; +} + +.nav-trigger:checked + label .navicon:before, +.nav-trigger:checked + label .navicon:after { + transition: 0.5s; +} + +/* Minus */ +.nav-trigger:checked + label { + -webkit-transform: scale(0.75); + transform: scale(0.75); +} + +/* × and + */ +.nav-trigger:checked + label.plus .navicon, +.nav-trigger:checked + label.x .navicon { + background: transparent; +} + +.nav-trigger:checked + label.plus .navicon:before, +.nav-trigger:checked + label.x .navicon:before { + -webkit-transform: rotate(-45deg); + transform: rotate(-45deg); + background: #FFF; +} + +.nav-trigger:checked + label.plus .navicon:after, +.nav-trigger:checked + label.x .navicon:after { + -webkit-transform: rotate(45deg); + transform: rotate(45deg); + background: #FFF; +} + +.nav-trigger:checked + label.plus { + -webkit-transform: scale(0.75) rotate(45deg); + transform: scale(0.75) rotate(45deg); +} + +.nav-trigger:checked ~ nav { + left: 0 !important; +} + +.nav-trigger:checked ~ .overlay { + display: block; +} + +.nav-trigger { + position: fixed; + top: 0; + clip: rect(0, 0, 0, 0); +} + +.overlay { + display: none; + position: fixed; + top: 0; + bottom: 0; + left: 0; + right: 0; + width: 100%; + height: 100%; + background: hsla(0, 0%, 0%, 0.5); + z-index: 1; +} + +@media only screen and (min-width: 320px) and (max-width: 680px) { + body { + overflow-x: hidden; + } + + nav { + background: #FFF; + width: 250px; + height: 100%; + position: fixed; + top: 0; + right: 0; + bottom: 0; + left: -250px; + z-index: 3; + padding: 0 10px; + transition: left 0.2s; + } + + .navicon-button { + display: inline-block; + position: fixed; + top: 1.5em; + right: 0; + z-index: 2; + } + + #main { + width: 100%; + min-width: 360px; + } + + #main h1.page-title { + margin: 1em 0; + } + + #main section { + padding: 0; + } + + footer { + margin-left: 0; + } +} + +/** Add a '#' to static members */ +[data-type="member"] a::before { + content: '#'; + display: inline-block; + margin-left: -14px; + margin-right: 5px; +} diff --git a/docs/styles/prettify-jsdoc.css b/docs/styles/prettify-jsdoc.css new file mode 100644 index 0000000..5a2526e --- /dev/null +++ b/docs/styles/prettify-jsdoc.css @@ -0,0 +1,111 @@ +/* JSDoc prettify.js theme */ + +/* plain text */ +.pln { + color: #000000; + font-weight: normal; + font-style: normal; +} + +/* string content */ +.str { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* a keyword */ +.kwd { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* a comment */ +.com { + font-weight: normal; + font-style: italic; +} + +/* a type name */ +.typ { + color: #000000; + font-weight: normal; + font-style: normal; +} + +/* a literal value */ +.lit { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* punctuation */ +.pun { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* lisp open bracket */ +.opn { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* lisp close bracket */ +.clo { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* a markup tag name */ +.tag { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* a markup attribute name */ +.atn { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* a markup attribute value */ +.atv { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* a declaration */ +.dec { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* a variable name */ +.var { + color: #000000; + font-weight: normal; + font-style: normal; +} + +/* a function name */ +.fun { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* Specify class=linenums on a pre to get line numbering */ +ol.linenums { + margin-top: 0; + margin-bottom: 0; +} diff --git a/docs/styles/prettify-tomorrow.css b/docs/styles/prettify-tomorrow.css new file mode 100644 index 0000000..b6f92a7 --- /dev/null +++ b/docs/styles/prettify-tomorrow.css @@ -0,0 +1,132 @@ +/* Tomorrow Theme */ +/* Original theme - https://github.com/chriskempson/tomorrow-theme */ +/* Pretty printing styles. Used with prettify.js. */ +/* SPAN elements with the classes below are added by prettyprint. */ +/* plain text */ +.pln { + color: #4d4d4c; } + +@media screen { + /* string content */ + .str { + color: #718c00; } + + /* a keyword */ + .kwd { + color: #8959a8; } + + /* a comment */ + .com { + color: #8e908c; } + + /* a type name */ + .typ { + color: #4271ae; } + + /* a literal value */ + .lit { + color: #f5871f; } + + /* punctuation */ + .pun { + color: #4d4d4c; } + + /* lisp open bracket */ + .opn { + color: #4d4d4c; } + + /* lisp close bracket */ + .clo { + color: #4d4d4c; } + + /* a markup tag name */ + .tag { + color: #c82829; } + + /* a markup attribute name */ + .atn { + color: #f5871f; } + + /* a markup attribute value */ + .atv { + color: #3e999f; } + + /* a declaration */ + .dec { + color: #f5871f; } + + /* a variable name */ + .var { + color: #c82829; } + + /* a function name */ + .fun { + color: #4271ae; } } +/* Use higher contrast and text-weight for printable form. */ +@media print, projection { + .str { + color: #060; } + + .kwd { + color: #006; + font-weight: bold; } + + .com { + color: #600; + font-style: italic; } + + .typ { + color: #404; + font-weight: bold; } + + .lit { + color: #044; } + + .pun, .opn, .clo { + color: #440; } + + .tag { + color: #006; + font-weight: bold; } + + .atn { + color: #404; } + + .atv { + color: #060; } } +/* Style */ +/* +pre.prettyprint { + background: white; + font-family: Consolas, Monaco, 'Andale Mono', monospace; + font-size: 12px; + line-height: 1.5; + border: 1px solid #ccc; + padding: 10px; } +*/ + +/* Specify class=linenums on a pre to get line numbering */ +ol.linenums { + margin-top: 0; + margin-bottom: 0; } + +/* IE indents via margin-left */ +li.L0, +li.L1, +li.L2, +li.L3, +li.L4, +li.L5, +li.L6, +li.L7, +li.L8, +li.L9 { + /* */ } + +/* Alternate shading for lines */ +li.L1, +li.L3, +li.L5, +li.L7, +li.L9 { + /* */ } diff --git a/docs/styles/prettify.css b/docs/styles/prettify.css new file mode 100644 index 0000000..629bde5 --- /dev/null +++ b/docs/styles/prettify.css @@ -0,0 +1,79 @@ +.pln { + color: #ddd; +} + +/* string content */ +.str { + color: #61ce3c; +} + +/* a keyword */ +.kwd { + color: #fbde2d; +} + +/* a comment */ +.com { + color: #aeaeae; +} + +/* a type name */ +.typ { + color: #8da6ce; +} + +/* a literal value */ +.lit { + color: #fbde2d; +} + +/* punctuation */ +.pun { + color: #ddd; +} + +/* lisp open bracket */ +.opn { + color: #000000; +} + +/* lisp close bracket */ +.clo { + color: #000000; +} + +/* a markup tag name */ +.tag { + color: #8da6ce; +} + +/* a markup attribute name */ +.atn { + color: #fbde2d; +} + +/* a markup attribute value */ +.atv { + color: #ddd; +} + +/* a declaration */ +.dec { + color: #EF5050; +} + +/* a variable name */ +.var { + color: #c82829; +} + +/* a function name */ +.fun { + color: #4271ae; +} + +/* Specify class=linenums on a pre to get line numbering */ +ol.linenums { + margin-top: 0; + margin-bottom: 0; +}