Home Manual Reference Source Repository

References

Class Summary

Static Public Class Summary
public

Represents that an argument erroneously has an empty string value.

since 0.0.1
public

Represents that an argument has violated a requirement.

since 0.0.1
public

Represents that an argument erroneously has a value of false.

since 0.0.1
public

Represents that an argument erroneously has a falsy value.

since 0.0.1
public

Represents that an argument erroneously has a value of NaN.

since 0.0.1
public

Represents that an argument erroneously has a value of null.

since 0.0.1
public

Represents that an argument has an invalid type or an object with the incorrect structure.

since 0.0.1
public

Represents that an argument erroneously is 'undefined'.

since 0.0.1
public

Represents that a string argument erroneously has only whitespace characters.

since 0.0.1
public

Represents that an argument erroneously has a value of zero.

since 0.0.1
public
public
public
public
public

Function Summary

Static Public Function Summary
public

asArray(T: *, valueOrSequence: T | Iterable<T>, ctor: function(...args: any[]): T): Array<T>

Converts an argument that could either be a value of a type or a sequence of that type to an array of that type.

since 0.0.1
public

asIterable(T: *, valueOrSequence: T | Iterable<T>, ctor: function(...args: any[]): T): Iterable<T>

Converts an argument that could either be a value of a type or a sequence of that type to a sequence of that type.

since 0.0.1
public

* concat(T: *, sequence: Iterable<T>, items: Iterable<T>[]): Iterable<T>

Concatenates a sequence of a type with zero or more other sequences of that type.

since 0.0.1
public

error(messages: *): *

public

every(T: *, sequence: Iterable<T>, test: ElementTest<T>): boolean

Returns a value indicating whether every element fulfills the specified test.

since 0.0.1
public

* filter(T: *, sequence: Iterable<T>, test: ElementTest<T>): Iterable<T>

Returns a subset of the sequence of those elements that pass the specified test.

since 0.0.1
public

find(T: *, sequence: Iterable<T>, test: ElementTest<T>): T | undefined

Returns the first value matching the specified test or undefined if no match was found.

since 0.0.1
public

get_Errors(messages: *): *

public

includes(T: *, sequence: Iterable<T>, value: T, fromIndex: number): boolean

Returns a value indicating whether a match for the specified test was found.

since 0.0.1
public

isError(value: *): *

public

isIterable(value: *): *

public
public

makeIsIterable(elementTypeGuard: *, deep: boolean): *

public

* map(T: *, U: *, sequence: Iterable<T>, converter: ElementConverter<T, U>): Iterable<U>

Returns a sequence of elements that are the result of calling the specified converter function on each element.

since 0.0.1
public

reduce(T: *, U: *, sequence: Iterable<T>, accumulator: ElementAccumulator<T, U>, initialValue: T): Iterable<U>

Aggregates a sequence to a single computed element value.

since 0.0.1
public

* slice(T: *, sequence: Iterable<T>, begin: number, end: number): *

Returns a segment of the original sequence.

since 0.0.1
public

some(T: *, sequence: Iterable<T>, test: ElementTest<T>): boolean

Returns a value indicating whether any of the elements of a sequence pass the specified test.

since 0.0.1
public

toMap(TKey: *, TValue: *, sequence: Iterable<T>, keySelector: function(value: TValue): TKey): Map<TKey, TValue>

Converts a sequence to a Map using the specified key selector function.

since 0.0.1
public

verifyArgument(T: *, name: string, value: T, test: function(value: T), message: string | function(value: string): string)

Throws an error if the specified argument value does not pass the specified test.

since 0.0.1
public

verifyArray(T: *, name: string, value: T, message: string | function(value: string): string)

Throws an error if the specified argument is not an Array.

since 0.0.1
public

verifyBoolean(name: string, value: boolean, message: string | function(value: string): string)

Throws an error if the specified argument is not strictly a boolean value.

since 0.0.1
public

verifyDefined(T: *, name: string, value: T, message: string | function(value: string): string)

Throws an error if the specified argument is undefined.

since 0.0.1
public

verifyFunction(name: string, value: Function, message: string | function(value: string): string)

Throws an error if the specified argument is not strictly a function expression.

since 0.0.1
public

verifyIterable(T: *, name: string, value: T, message: string | function(value: string): string)

Throws an error if the specified argument does not support iteration.

since 0.0.1
public

verifyNonEmpty(name: string, value: string, message: string | function(value: string): string)

Throws an error if the specified argument value is not a non-empty string.

since 0.0.1
public

verifyNonZero(name: string, value: number, message: string | function(value: string): string)

Throws an error if the specified argument value is not a non-zero number.

since 0.0.1
public

verifyNotNull(name: string, value: number, message: string | function(value: string): string)

Throws an error if the specified argument value is undefined or null.

since 0.0.1
public

verifyNotWhitespace(name: string, value: string, message: string | function(value: string): string)

Throws an error if the specified argument is not a string with non whitespace characters.

since 0.0.1
public

verifyNumber(name: string, value: number, message: string | function(value: string): string)

Throws an error if the specified argument value is not a number or has a value of NaN.

since 0.0.1
public

verifyObject(name: string, value: Object, message: string | function(value: string): string)

Throws an error if the specified argument value is not an Object.

since 0.0.1
public

verifyString(name: string, value: string, message: string | function(value: string): string)

Throws an error if the specified argument value is not a string.

since 0.0.1
public

verifyTrue(name: string, value: boolean, message: string | function(value: string): string)

Throws an error if the specified argument value is not a boolean with the value 'true'.

since 0.0.1
public

verifyTruthy(T: *, name: string, value: T, message: string | function(value: string): string)

Throws an error if the specified argument value is not truthy.

since 0.0.1

Variable Summary

Static Public Variable Summary
public
public
public

Typedef Summary

Static Public Typedef Summary
public

ElementAccumulator(T: *, U: *, previousValue: U, currentValue: T, index: currentIndex, sequence: Iterable<T>): U: function

public

ElementConverter(T: *, U: *, element: T, index: number, sequence: Iterable<T>): U: function

public

ElementTest(T: *, element: T, index: number, sequence: Iterable<T>): boolean: function