Class: Exclude

Exclude

new Exclude(values)

Create a new Exclude.
Parameters:
Name Type Description
values Array.<(Name.Component|Buffer|Exclude.ANY)> (optional) An array where each element is either a Name.Component, Buffer component or Exclude.ANY.
Source:

Methods

(static) compareComponents()

Return -1 if component1 is less than component2, 1 if greater or 0 if equal. A component is less if it is shorter, otherwise if equal length do a byte comparison.
Source:

appendAny()

Append an Exclude.ANY element.
Source:
Returns:
This Exclude so that you can chain calls to append.

appendComponent(component)

Append a component entry, copying from component.
Parameters:
Name Type Description
component Name.Component | Buffer
Source:
Returns:
This Exclude so that you can chain calls to append.

clear()

Clear all the entries.
Source:

get(i) → {Exclude.ANY|Name.Component}

Get the entry at the given index.
Parameters:
Name Type Description
i number The index of the entry, starting from 0.
Source:
Returns:
Exclude.ANY or a Name.Component.
Type
Exclude.ANY | Name.Component

getChangeCount() → {number}

Get the change count, which is incremented each time this object is changed.
Source:
Returns:
The change count.
Type
number

matches()

Return true if the component matches any of the exclude criteria.
Source:

size() → {number}

Get the number of entries.
Source:
Returns:
The number of entries.
Type
number

toUri()

Return a string with elements separated by "," and Exclude.ANY shown as "*".
Source: