Interface IFunctionCollection

Collections of IFunction.

interface IFunctionCollection {
    add(options: IFunction | IFunctionCollection.AddOptions): IFunction;
    getByName(name: string): IFunction;
    getCount(): number;
    search(options?: IFunctionCollection.SearchOptions): IFunction[];
}

Hierarchy (View Summary)

ICollection
- IFunctionCollection

Index

Methods

add getByName getCount search

Methods

add

add(options: IFunction | IFunctionCollection.AddOptions): IFunction
Add a custom function to a collection.
Parameters
- options: IFunction | IFunctionCollection.AddOptions
Returns IFunction

getByName

getByName(name: string): IFunction
Convenience method for searching by name. This is functionally equivalent to search({ name });
Parameters
- name: string
  The name to search for This is case insensitive.
Returns IFunction

getCount

getCount(): number
Returns the total items available.

Returns number
Remarks
Useful as a quick escape for search.

Inherited from ICollection.getCount

search

search(options?: IFunctionCollection.SearchOptions): IFunction[]
Returns functions that match the search criteria.

If no search criteria is provided, all items will be returned.
Parameters
- Optionaloptions: IFunctionCollection.SearchOptions
  IFunctionCollection.SearchOptions
Returns IFunction[]