@breadstone/ziegel-core

Namespaces

Namespace	Description
AnyExtensions	-
ArrayExtensions	-
ColorExtensions	Color extensions.
DateExtensions	-
DayOfWeek	-
DayOfWeekName	-
Defaults	-
FunctionConstructorExtensions	-
FunctionExtensions	-
MapExtensions	-
Nullable	-
NumberConstructorExtensions	-
NumberExtensions	-
ObjectExtensions	-
Optional	-
StringConstructorExtensions	-
StringExtensions	-

Enumerations

Enumeration	Description
DateTimeKind	-
DayOfWeek	A enum that represents the day of week.
Month	A Month value enum.
PasswordScore	-

Classes

Class	Description
AnonymousDisposable	Represents a disposable resource that can be disposed with a custom action.
ArgumentException	Exception class for invalid arguments to a method. The ArgumentException is thrown when an argument does not meet the contract of the method. Ideally it should give a meaningful error message describing what was wrong and which parameter is incorrect.
ArgumentFormatException	Exception class for invalid argument formats to a method.
ArgumentNullException	Exception class for null arguments to a method. The ArgumentNullException is thrown when an argument is null when it shouldn't be.
ArgumentOutOfRangeException	Exception class for method arguments outside of the legal range. The ArgumentOutOfRangeException is thrown when an argument is outside the legal range for that argument.
ArgumentTypeException	Exception class for invalid argument types to a method. The ArgumentTypeException is thrown when an argument does not match the expected type for
Bag	A Bag is a special kind of a Set in which members are allowed to appear more than once.
CMYK	Represents a color in the CMYK (Cyan, Magenta, Yellow, Key/Black) color model.
Color	Represents a color in the RGB (Red, Green, Blue) color model.
Colors	Colors - A collection of well-known Colors
CompositeDisposable	Represents a group of disposables that are disposed together.
Console	Represtents a wrapper for console calls.
DateRange	-
DateTime	-
DateTimeRange	-
Deferred	-
Disposable	Provides static methods for creating disposable objects.
DuplicateKeyException	Exception class for duplicate keys in a collection. The DuplicateKeyException is thrown when an attempt is made to add a key to a collection that already contains that key.
Enum	The Enum class.
Event	Class representing an event that can be subscribed to and invoked.
EventArgs	Class representing the arguments for an event.
EventInvoker	Class that allows for the invocation of events with specific arguments.
Exception	The base class for all exceptional conditions.
FormatException	Exception class for format errors.
Formats	A class that manages format providers for formatting values.
Guard	Utility class for validating method arguments. The Guard class provides static methods to validate method arguments and throw appropriate exceptions if the validation fails.
Guid	-
HashAlgorithm	-
Heap	A heap is a binary tree, where the nodes maintain the heap property: each node is smaller than each of its children and therefore a MinHeap This implementation uses an array to store elements.
HSB	Represents a color in the HSB (Hue, Saturation, Brightness) color model.
HSL	Represents a color in the HSL (Hue, Saturation, Luminance) color model.
IndexOutOfRangeException	Exception class for index out of range errors. The IndexOutOfRangeException is thrown when an index is outside the bounds of an array or collection.
Interval	Represents a timer that executes a handler at specified intervals.
InvalidOperationException	Exception class for denoting an object was in a state that made calling a method illegal. * The InvalidOperationException is thrown when a method call is invalid for the object's current state.
KeyNotFoundException	Exception class for denoting an object was in a state that made calling a method illegal. * The KeyNotFoundException is thrown when a key is not found in a collection or dictionary.
KeyValuePair	-
Lazy	The Lazy class.
LinkedList	-
Linq	Simplest abstraction for building an extensible iterable query.
MD5	-
MD5CryptoServiceProvider	-
NotFoundException	Exception class for denoting an object was not found. * The NotFoundException is thrown when an object or resource is not found.
NotImplementedException	Exception thrown when a requested method or operation is not implemented. The NotImplementedException is used to indicate that a method or operation has not been implemented yet.
NotSupportedException	Exception class for methods or operations that are not supported. The NotSupportedException is thrown when a method or operation is not supported by the current implementation.
NullReferenceException	Exception class for null reference errors. The NullReferenceException is thrown when an operation is attempted on a null reference.
NumberRange	Represents a range of numbers.
OverflowException	Exception class for overflow errors. The OverflowException is thrown when an arithmetic operation exceeds the limits of the data type.
PasswordStrengthValidator	-
Queue	A queue is a First-In-First-Out (FIFO) data structure, the first element added to the queue will be the first one to be removed. This implementation uses a linked list as a container.
Random	A random number generator.
Range	Abstract class representing a range of values.
RegexPatterns	-
RGB	Represents a color in the RGB (Red, Green, Blue) color model.
Set	A set is a data structure that contains no duplicate items.
SHA1	-
SHA1CryptoServiceProvider	-
SR	Represents the internal string resources.
Stack	A Stack is a Last-In-First-Out (LIFO) data structure, the last element added to the stack will be the first one to be removed. This implementation uses a linked list as a container.
Stopwatch	A simple stopwatch implementation that can be used to measure elapsed time. It provides methods to start, stop, reset, and restart the stopwatch. The elapsed time can be retrieved in milliseconds.
StringBuilder	A mutable string builder that allows for efficient string concatenation.
StringFormatter	A formatter for strings that allows for formatting with named values.
TimeSpan	-
TimeSpanRange	-
TypeGuard	Utility class for type checking. The TypeGuard class provides static methods to check the type of a value.
ValueEventArgs	Class representing the arguments for an event that carries a value.
Version	-
YUV	Represents a color in the YUV (Luminance, Chrominance) color model.

Interfaces

Interface	Description
ICancelable	Disposable resource with disposal state tracking.
ICMYK	Interface representing a CMYK color model.
IConstructable	Interface for a constructable type.
IDisposable	Interface for disposable objects.
IEquatable	Interface for objects that can be compared for equality with other objects of the same type.
IEventArgs	Interface representing the arguments for an event.
IFormat	Interface for formatting values.
IFormatProvider	Interface for a format provider.
IFormattable	Interface for objects that can be formatted as strings.
IHSB	Interface representing a color in the HSB (Hue, Saturation, Brightness) color model.
IHSL	Interface representing a color in the HSL (Hue, Saturation, Luminance) color model.
IIndexer	An interface that defines an indexer for both string and number keys.
INumberIndexer	An interface that defines an indexer for number keys.
IObservable	Interface for observable objects that can be subscribed to by observers.
IObserver	Interface for observers that can receive notifications from observables.
IRange	Interface representing a range of values.
IRGB	Interface representing a color in the RGB (Red, Green, Blue) color model.
IStringable	Interface for objects that can be converted to a string representation.
IStringIndexer	An interface that defines an indexer for string keys.
ISupport	Represents a support for different system api's.
ITimeSpan	Represents the ITimeSpan interface.
IYUV	Interface representing a color in the YUV color model.

Type Aliases

Type Alias	Description
Action	-
Action1	-
Action2	-
Action3	-
Action4	-
Action5	-
Action6	-
Action7	-
Action8	-
Class	-
Constructor	-
DayOfWeekName	A type that represents the day of week name.
DeepPartial	A type that makes all properties and deep properties partial.
DeepRequired	A type that makes all properties and deep properties required.
Diff	-
Func	-
Func1	-
Func2	-
Func3	-
Func4	-
Func5	-
Func6	-
Func7	-
Func8	-
IEventCallback	Interface for an event callback function.
Indexable	-
IStandardFormatter	Interface for standard formatters that convert values to strings.
JsonArray	-
JsonObject	-
JsonPrimitive	-
JsonValue	-
MatchingKeys	-
MemberLaves	A type that detects all property laves of a object.
MemberPaths	A type that detects all property paths of a object.
Merge	-
NonEmptyArray	A type of a non empty array.
NonOptional	-
NonUndefined	-
Nullable	-
ObservableLike	Represents a value that can be either a plain value or an observable.
Omit	-
Optional	-
Overwrite	-
Predicate	-
Prototypeable	Type alias for a prototype.
RangeLike	Represents a range like object.
ReturnValueConstraint	A contsraint for return values.
ReturnValueErrorConstraint	A contsraint for return values with error.
Undefinable	-
Unwrap	-
WithRequired	-

Variables

Variable	Description
DAY_OF_WEEK	A array that contains all days of a week.
DAY_OF_WEEK_NAMES	A array that contains all day names of a week.

Functions

Function	Description
aggregate	An iterable transform that applies an accumulator function over a sequence. The specified initialValue is used as the initial accumulator value, and the specified function is used to select the result value. If no initialValue is specified, the first entry in the sequence is used.
all	An iterable transform that resolves false if the predicate ever returns false. Otherwise true.
any	An iterable transform that resolves true if the predicate ever returns true. Otherwise false. If no predicate is provided, will resolve true if the sequence is not empty.
append	An iterable filter that bypasses a specified number of elements in a sequence and then returns the remaining elements.
asArray	Returns an array (copy) of all the elements in a sequence if the sequence isn't already an array. If the sequence is an array, it's returned as is.
ascending	Default ascending sort delegate for primitive only iterables.
average	Returns the average of a sequence of numbers.
buffer	An iterable filter that (once started) pre-fetches entries from the source up to the size.
concat	Concatenates the provided sequences.
contains	An iterable transform that resolves true if the provided sequence contains the entry. Otherwise false.
count	Returns the number of entries in a sequence.
defaultIfEmpty	A iterable filter that returns the elements of the specified sequence or the specified value in a collection if the sequence is empty.
Delay	A decorator delays a method with a setTimeout function. decorator usage as MethodDecorator.
descending	Default descending sort delegate for primitive only iterables.
distinct	An iterable filter that returns distinct elements from a sequence.
elementAt	Produces a function that returns the element at a specified index in a sequence.
elementAtOrDefault	Produces a function that returns the element at a specified index in a sequence or a default value if out of bounds.
empty	An iterable that yields no elements.
exclude	An iterable filter that returns all elements except for any in the exclusion sequence.
first	Returns the first element of a sequence.
firstOrDefault	An iterable transform that returns the first element of a sequence, or a default value if no element is found.
fromDisposable	Create an observable from a disposable.
groupBy	An iterable filter that groups the elements of a sequence according to a specified key selector function and creates an iterable from each group and its key.
hasAny	Returns true if the sequence is not empty.
indexOf	An iterable transform that resolves true if the provided sequence contains the value. Otherwise false.
isClass	-
isCMYK	-
isConstructor	-
isEmpty	Returns true if the sequence is empty.
isHSB	-
isHSL	-
isNonEmptyArray	A non empty array type guard function
isNotNullable	Type guard that checks of not null.
isNotOptional	Type guard that checks of not null and undefined.
isNotUndefined	-
isNullable	Type guard that checks of null.
isObservableLike	Checks if a value is an observable-like type.
isOptional	Type guard that checks of null and undefined.
isPrototypeable	Type guard to check a prototype.
isRangeLike	The isRangeLike() method determines whether an object is an RangeLike This function returns true if the object is an RangeLike, and false if not.
isRGB	-
isUndefined	-
isYUV	-
iterateIndexes	Returns an iterator that iterates the provided ArrayLike using length and index.
joinStrings	Joins a set of strings using the provided separator.
last	Returns the first element of a sequence.
lastIndexOf	An iterable transform that resolves true if the provided sequence contains the value. Otherwise false.
lastOrDefault	An iterable transform that returns the last element of a sequence, or a default value if no element is found.
linq	Converts any iterable into a LINQ style iterable. Import filters and transforms to create a query. Use a resolution to get a result.
max	Returns the entry in the sequence that has the highest/greatest value.
Memoize	A decorator that handle a method memorization. Decoration usage as MethodDecorator.
merge	Concatenates the sequences.
min	Returns the entry in the sequence that has the lowest/least value.
notNull	Filters out null values.
notNullOrUndefined	Filters out null or undefined values.
notUndefined	Filters out undefined values.
ofType	An iterable filter that only returns elements of the type (constructor) provided. Example: Calling ofType(Number)(sequence) will filter all numbers.
onComplete	An iterable filter that invokes the provided action if there are no more entries to iterate.
onError	An iterable filter that invokes the provided handler if there was an error while iterating. Any error while iterating assumes no more results and the iteration will be complete after the error. The handler can decide if it wants to rethrow the error or not.
onStart	An iterable filter that invokes the provided action before iterating results.
optionalOtherwise	Returns the otherwise value if a value is optional.
orderBy	An iterable filter that orders elements by a primitive value provided by the key selector.
orderUsing	An iterable filter that orders elements by use of a comparison function.
otherwiseNullable	Returns the otherwise value if a value is nullable.
panic	Throws an exception with the provided message or error object.
patch	-
prepend	An iterable filter that bypasses a specified number of elements in a sequence and then returns the remaining elements.
product	Returns the product (*) of a sequence of numbers. Returns NaN if sequence is empty or if any entries are NaN.
range	Generates a sequence of numbers within a specified range.
registerResource	Registers a resource definition by name and target object.
repeat	Generates a sequence that contains one repeated value.
repeatSequence	Generates a sequence that contains each value in the provided sequence and repeats.
reverse	Returns an array (copy) of all the elements of a sequence in reverse order.
rows	Returns the rows from a given set of iterables representing columns.
same	Returns the sequence provided.
select	An iterable filter that transforms (maps / projects) the output from the contained elements.
selectMany	An iterable filter that merges the output of contained iterables.
sequenceEqual	Resolves true if the sequences are equal.
single	Returns an entry from a singular sequence. Will throw if no elements or more than one.
singleOrDefault	Returns an entry from a singular sequence or a default value if empty. Throws if more than one entry.
skip	An iterable filter that bypasses a specified number of elements in a sequence and then returns the remaining elements.
skipLast	An iterable filter that returns everything from the sequence except the last count of items.
skipUntil	An iterable filter that bypasses elements in sequence until the predicate condition returns is true. Inverse of skipWhile.
skipWhile	An iterable filter that bypasses elements in sequence while the predicate condition is true and if false will iterate the rest. Inverse of skipUntil.
sum	Returns the sum (+) of a sequence of numbers. Returns 0 if sequence is empty. Returns NaN if any entries are NaN.
sumAndCount	Returns the sum .value of a sequence and the number of entries .count.
take	An iterable filter that returns a specified number of contiguous elements from the start of a sequence.
takeLast	An iterable filter that returns a specified number of contiguous elements from the start of a sequence.
takeUntil	An iterable filter that will return results until the predicate condition is true.
takeWhile	An iterable filter that will return results while the predicate condition is true and stops when false.
toArray	Returns an array (copy) of all the elements in a sequence.
toMap	Returns a map of all elements.
unfold	A generator function for creating entries based upon the previous entry.
union	Produces the set union of all sequences provided.
using	Executes a function with a disposable object and ensures that the object is disposed after the function execution.
where	An iterable filter that only returns elements that match the provided predicate.
zip	Produces a sequence that is combination of the two sequences.