Class Expectation<T>
The expectation class is the class that is actually instantiated for +
Class Expectation<T>
The expectation class is the class that is actually instantiated for any expectation. It implements all interfaces for expectations, even the finished expectation ones.
Type Parameters
T
Hierarchy
- FinishedExpectation
- Expectation
Index
Constructors
to
- to
Have Type(typeName): Expectation<T> & IFinishedExpectation Parameters
typeName: string
Returns Expectation<T> & IFinishedExpectation
Inherit Doc
to
- to
Match(regexp): Expectation<T> & IFinishedExpectation Parameters
regexp: RegExp
Returns Expectation<T> & IFinishedExpectation
Inherit Doc
to
- to
Start With(start): Expectation<T> & IFinishedExpectation Parameters
start: string
Returns Expectation<T> & IFinishedExpectation
Inherit Doc
-
Class FinishedExpectationAbstract
This abstract class provides finished expectation behavior for +
Class FinishedExpectationAbstract
This abstract class provides finished expectation behavior for all actions based on the fact that it's subclass provides an implementation for getResult.
Hierarchy
- FinishedExpectation
Implements
Index
Constructors
Type Parameters
T
Parameters
value: T
Returns T
Class JoinedExpectation
A joined expectation consist of multiple expectations joined by a specific +
Class JoinedExpectation
A joined expectation consist of multiple expectations joined by a specific joiner function. A JoinedExpectation implements FinishedExpectation, where the result is calculated using the given joiner function.
Currently two join forms are provided, Expectations!and, @@ -25,4 +25,4 @@
or
or
or
Type Parameters
T
Parameters
value: T
Returns T
Class Matchers
This object contains a series of matchers, that is, a series of functions +
Class Matchers
This object contains a series of matchers, that is, a series of functions
that can be called with the actual value (and in cases a series of arguments)
and returns a boolean, true if the value satisfies the matcher, and false
otherwise.
Static to
Static to
Parameters
actual: string
expected: any
Returns boolean
Class Board
This class models a Gobstones Board with all it's associated behavior. +
Class Board
This class models a Gobstones Board with all it's associated behavior. Note that an instance of this class implements BoardDefinition, so it can be used as a valid description of a board in the Gobstones Interpreter and is @@ -458,4 +458,4 @@
Throws
removeRow on an instance.
Class BoardError
The base class of the error hierarchy that is thrown when +
Class BoardError
Hierarchy
Index
Constructors
Properties
Constructors
constructor
- new
Board Error(name, message): BoardError Parameters
name: string
message: string
Returns BoardError
Properties
Readonly is
A boolean that specifies the instance as an error. Always true.
Class Cell
A cell
+Class Cell
A cell
Hierarchy
- EventEmitter<CellEvents>
- Cell
Implements
Index
Constructors
Properties
Throws
removeStones on an instance with any color and value.
Class Color
This enum represent the valid Gobstones Colors. +
Class Color
This enum represent the valid Gobstones Colors. It provides a set of singleton cases, for each possible value, as well as static accessors for each case name string (that should be used as key for representing directions).
@@ -98,4 +98,4 @@And they are cyclic, that is, the previous color of Blue is Green.
Parameters
color: Color
The color to obtain the previous value from.
Returns Color
The previous color of the given one.
-Class Direction
This class represents the valid Gobstones Directions. +
Class Direction
This class represents the valid Gobstones Directions. It provides a set of singleton cases, for each possible value, as well as static accessors for each case name string (that should be used as key for representing directions).
@@ -133,4 +133,4 @@And they are cyclic, that is, the previous direction of North is West.
Parameters
dir: Direction
The direction to obtain the previous value from.
Returns Direction
The previous direction of the given one.
-Class InvalidBoardDescription
This error is thrown when attempting to create a board +
Class InvalidBoardDescription
This error is thrown when attempting to create a board with invalid data.
Hierarchy
- BoardError
- InvalidBoardDescription
Index
Constructors
Properties
Private height
The height attempted to create the board with
Readonly is
A boolean that specifies the instance as an error. Always true.
Private width
The width attempted to create the board with
-Class InvalidCellReading
This error is thrown when attempting to read a cell, a +
Class InvalidCellReading
This error is thrown when attempting to read a cell, a column or a row but an invalid location is given.
Hierarchy
- BoardError
- InvalidCellReading
Index
Constructors
Properties
Constructors
constructor
- new
Invalid Cell Reading(attempt, failingCoordinate): InvalidCellReading Parameters
attempt: CellReadingActionAttempt
failingCoordinate: CellLocation
Returns InvalidCellReading
Properties
Readonly attempt
The action attempted to be performed
Readonly failing
The coordinate the head was attempted to set into
Readonly is
A boolean that specifies the instance as an error. Always true.
Class InvalidSizeChange
This error is thrown when attempting to change the size of the board, +
Class InvalidSizeChange
This error is thrown when attempting to change the size of the board, but an invalid size is given
Hierarchy
- BoardError
- InvalidSizeChange
Index
Constructors
Properties
Readonly new
The new width of the board
Readonly previous
The previous height of the board
Readonly previous
The previous width of the board
-Class InvalidStonesAmount
This error is thrown when attempting to change the stones amount +
Class InvalidStonesAmount
This error is thrown when attempting to change the stones amount with an invalid amount of stone (negative amount).
Hierarchy
- BoardError
- InvalidStonesAmount
Index
Constructors
Properties
Readonly color
The color of the stones attempted to change
Readonly is
A boolean that specifies the instance as an error. Always true.
Readonly previous
The state the cell was previously in
-Class LocationFallsOutsideBoard
This error is thrown when attempting to move the head, but an +
Class LocationFallsOutsideBoard
This error is thrown when attempting to move the head, but an invalid location is given.
Hierarchy
- BoardError
- LocationFallsOutsideBoard
Index
Constructors
Properties
Readonly failing
The coordinate the head was attempted to set into
Readonly is
A boolean that specifies the instance as an error. Always true.
Readonly previous
The previous coordinate the head was in
-Class DefinedSourcePosition
A DefinedSourcePosition points to a particular position, different from EndOfString, +
Class DefinedSourcePosition
A DefinedSourcePosition points to a particular position, different from EndOfString, in a source given by a SourceReader.
It provides the right implementation for the operations given by its superclasses.
Hierarchy
- StringSourcePosition
- DefinedSourcePosition
Index
API: Access
It is supposed to be used only by SourceReader.
Returns number
_the
- get _theVisibleCharIndex(): number
PrivateThe index indicating the exact char in the visible input string in the source input.
It is supposed to be used only by SourceReader.
-Returns number
Returns number
Class EndOfInputSourcePosition
An EndOfInputSourcePosition points to the EndOfInput position in a specific +
Class EndOfInputSourcePosition
An EndOfInputSourcePosition points to the EndOfInput position in a specific SourceReader. That position is reached when all input strings have been processed. It is a special position, because it does not point to a particular position inside the @@ -137,4 +137,4 @@
Parameters
sourceReader: SourceReader
line: number
column: number
regions: string[]
Returns EndOfInputSourcePosition
Parameters
sourceReader: SourceReader
line: number
column: number
regions: string[]
Returns EndOfInputSourcePosition
Class EndOfStringSourcePosition
An EndOfStringSourcePosition points to the EndOfString position in a specific +
Class EndOfStringSourcePosition
An EndOfStringSourcePosition points to the EndOfString position in a specific SourceReader. That position is reached when all characters in the current input string have been processed. It is a special position, because it does not point to a particular position inside the @@ -153,4 +153,4 @@
It is supposed to be used only by SourceReader.
Returns number
_the
- get _theVisibleCharIndex(): number
PrivateThe index indicating the exact char in the visible input string in the source input.
It is supposed to be used only by SourceReader.
-Returns number
Returns number
Class ErrorAtEndOfInputBy
The error to produce when a function that is not supposed to be used at EndOfInput is called.
+Class ErrorAtEndOfInputBy
The error to produce when a function that is not supposed to be used at EndOfInput is called.
Hierarchy
- SourceReaderErrorBy
- ErrorAtEndOfInputBy
Index
Constructors
Constructors
constructor
- new
Error At End Of Input By(operation, context): ErrorAtEndOfInputBy The constructor for ErrorAtEndOfInputBy errors.
Parameters
operation: string
A string indicating which function inform as the producer of the error.
context: string
A string indicating the context in which the function produce the error.
-
Returns ErrorAtEndOfInputBy
Returns ErrorAtEndOfInputBy
Class ErrorAtEndOfStringBy
The error to produce when a function that is not supposed to be used at EndOfString is called.
+Class ErrorAtEndOfStringBy
The error to produce when a function that is not supposed to be used at EndOfString is called.
Hierarchy
- SourceReaderErrorBy
- ErrorAtEndOfStringBy
Index
Constructors
Constructors
constructor
- new
Error At End Of String By(operation, context): ErrorAtEndOfStringBy The constructor for ErrorAtEndOfStringBy errors.
Parameters
operation: string
A string indicating which function inform as the producer of the error.
context: string
A string indicating the context in which the function produce the error.
-
Returns ErrorAtEndOfStringBy
Returns ErrorAtEndOfStringBy
Class ErrorNoInput
The error to produce when a SourceReader is called with no input (an empty object or array).
+Class ErrorNoInput
The error to produce when a SourceReader is called with no input (an empty object or array).
Hierarchy
- SourceReaderError
- ErrorNoInput
Index
Constructors
Constructors
constructor
- new
Error No Input(): ErrorNoInput The constructor for ErrorNoInput errors.
-Returns ErrorNoInput
Returns ErrorNoInput
Class ErrorUnmatchingPositionsBy
The error to produce when two positions related with different readers are used to determine +
Class ErrorUnmatchingPositionsBy
The error to produce when two positions related with different readers are used to determine a portion of the contents.
Hierarchy
- SourceReaderErrorBy
- ErrorUnmatchingPositionsBy
Index
Constructors
Constructors
constructor
- new
Error Unmatching Positions By(operation, context): ErrorUnmatchingPositionsBy The constructor for ErrorUnmatchingPositionsBy errors.
Parameters
operation: string
A string indicating which function inform as the producer of the error.
context: string
A string indicating the context in which the function produce the error.
-
Returns ErrorUnmatchingPositionsBy
Returns ErrorUnmatchingPositionsBy
Class KnownSourcePositionAbstract
A KnownSourcePosition points to a position in a specific SourceReader. +
Class KnownSourcePositionAbstract
A KnownSourcePosition points to a position in a specific SourceReader. It is created using the getPosition operation of a particular SourceReader instance. The obtained object indicates a position in the source associated with that reader, that may be @@ -216,4 +216,4 @@
Parameters
sourceReader: SourceReader
line: number
column: number
regions: string[]
Returns KnownSourcePosition
Parameters
sourceReader: SourceReader
line: number
column: number
regions: string[]
Returns KnownSourcePosition
Class SourcePositionAbstract
Instances of SourcePosition point to particular positions in the source given by a +
Class SourcePositionAbstract
Instances of SourcePosition point to particular positions in the source given by a SourceReader. They may be unknown or they may point to a particular SourceReader. All SourcePosition are created through SourceReader.
@@ -39,4 +39,4 @@ of the position (not suitable for persistance, as it looses information).See the documentation of UnknownSourcePosition and KnownSourcePosition for additional implementation details.
-Class SourceReader
A SourceReader allows you to read input from some source, either one single string of +
Class SourceReader
A SourceReader allows you to read input from some source, either one single string of content or several named or indexed source strings, in such a way that each character read registers its position in the source as a tuple index-line-column. That is, the main problem it solves is that of calculating the position of each character read @@ -311,4 +311,4 @@
Throws
KnownSourcePosition subclasses.
PRECONDITION: both positions correspond to this reader (and so are >= 0 -- not verified)
-Parameters
from: KnownSourcePosition
to: KnownSourcePosition
Returns string
Parameters
from: KnownSourcePosition
to: KnownSourcePosition
Returns string
Class SourceReaderError
The superclass for all SourceReader errors. +
Class SourceReaderError
The superclass for all SourceReader errors. It provides internationalization of error messages through a Translator. It also restores the prototype chain, as described in the Typescript Handbook.
@@ -10,4 +10,4 @@Optional interpolations: Record<string, any>
A record indicating values for interpolations
used in the value associated with the key
given. It may be undefined if there are none.
Returns SourceReaderError
Returns SourceReaderError
Class SourceReaderErrorBy
The superclass for all SourceReader errors with operation and context as
+
Class SourceReaderErrorBy
The superclass for all SourceReader errors with operation and context as
interpolations.
It constructs the corresponding interpolation.
Hierarchy
Index
Constructors
Constructors
constructor
- new
Source Reader Error By(key, operation, context): SourceReaderErrorBy The constructor for SourceReaderErrorBy errors.
Parameters
key: string
operation: string
A string indicating which function inform as the producer of the error.
context: string
A string indicating the context in which the function produce the error.
-
Returns SourceReaderErrorBy
Returns SourceReaderErrorBy
Class StringSourcePositionAbstract
A StringSourcePosition points to a particular position, different from EndOfInput, +
Class StringSourcePositionAbstract
A StringSourcePosition points to a particular position, different from EndOfInput, in a source given by a SourceReader.
It provides the right implementation for the operations given by its superclasses, KnownSourcePosition and SourcePosition. @@ -203,4 +203,4 @@
It is supposed to be used only by SourceReader.
Returns number
_the
- get _theVisibleCharIndex(): number
PrivateThe index indicating the exact char in the visible input string in the source input.
It is supposed to be used only by SourceReader.
-Returns number
Returns number
Class UnknownSourcePosition
An unknown source position does not point to any position in any source reader. +
Class UnknownSourcePosition
An unknown source position does not point to any position in any source reader. It is used when a position must be provided, but no one is known.
As source positions are only created by a SourceReader, there is a static member of it, the UnknownPosition, @@ -22,4 +22,4 @@ proper information.
Implementation: Protected for Source Reader
Private constructor
- new
Unknown Source Position(): UnknownSourcePosition PrivateReturns an unknown source position. It is intended to be used only by SourceReader.
-Returns UnknownSourcePosition
Returns UnknownSourcePosition
Class Translator<TLocale>
A Translation consist of an object that hold the state of the current +
Class Translator<TLocale>
A Translation consist of an object that hold the state of the current locale being used, and allows for switching between different locales and obtain translated strings.
The translation expects a locale to be given as the language definition, @@ -60,4 +60,4 @@ to replace any interpolation matcher in the translated text (any text in between ${}) by the value of the corresponding key.
Returns string
A translated string
-Class BiMap<K, V>
A bidirectional map is a map that represents biyective association between +
Class BiMap<K, V>
A bidirectional map is a map that represents biyective association between
keys and values, and such that it can be accessed both by the keys or by the
values. The types of both the keys and the values should be comparable by
identity (=== comparison).
Parameters
value: V
The value to search
Returns boolean
keys
values
Returns V[]
Class CLIApp
The CLIApp class is the class to extend in order to define your CLI based +
Class CLIApp
The CLIApp class is the class to extend in order to define your CLI based application.
Hierarchy
- CLICommandBuilder
- CLIApp
write
Returns void
Class CLICommandBuilder
A builder for a CLI command. May be the main command of the app (CLIApp) +
Class CLICommandBuilder
A builder for a CLI command. May be the main command of the app (CLIApp) extends this class) or a sub-command.
Hierarchy
- CLICommandBuilder
write
Returns void
@gobstones/gobstones-core - v0.4.5
gobstones-core
A set of utility types, interfaces and classes that are used through all the Gobstones Platform repositories.
+@gobstones/gobstones-core - v0.4.6
gobstones-core
A set of utility types, interfaces and classes that are used through all the Gobstones Platform repositories.
Install
Install with npm by using
npm install @gobstones/gobstones-core
import { cli } from '@gobstones/gobstones-core/cli';
Contributing
See the Gobstones Platform Contributions Guidelines to contribute.
-Function and
- and(...expectations): IFinishedExpectation
Create a new JoinedExpectation where all the expectations need to +
and | @gobstones/gobstones-core - v0.4.6 +\ No newline at end of file +Function and
- and(...expectations): IFinishedExpectation
Create a new JoinedExpectation where all the expectations need to have a
trueresult in order for the result of the joined one to be alsotrue. That is, an expectation that joins it's components with a logical and.Parameters
Rest...expectations: IFinishedExpectation[]A list of expectations that need to be fulfilled in order to return
-trueas result.
Returns IFinishedExpectation
Returns IFinishedExpectation
Function expect
- expect(element?): INumberExpectation
Create a new expectation over an element. The type of the returned expectation +
expect | @gobstones/gobstones-core - v0.4.6 +\ No newline at end of file +Function expect
- expect(element?): INumberExpectation
Create a new expectation over an element. The type of the returned expectation depends on the type of the element passed, and thus, different matchers may be executed over the expectation. The generic matchers can be called over any expectation for any element, this include:
@@ -54,4 +54,4 @@- toBeInstanceOf
Parameters
Optionalelement: numberThe element that is going to be queried by the created expectation.
-
Returns INumberExpectation
- expect(element?): IStringExpectation
Parameters
Optionalelement: string
Returns IStringExpectation
- expect<T>(element?): IArrayExpectation<T>
Type Parameters
T
Parameters
Optionalelement: T[]
Returns IArrayExpectation<T>
- expect<T>(element?): IObjectExpectation<T>
Type Parameters
T
Parameters
Optionalelement: T
Returns IObjectExpectation<T>
Returns INumberExpectation
Parameters
Optionalelement: string
Returns IStringExpectation
Type Parameters
T
Parameters
Optionalelement: T[]
Returns IArrayExpectation<T>
Type Parameters
T
Parameters
Optionalelement: T
Returns IObjectExpectation<T>
Function or
- or(...expectations): IFinishedExpectation
Create a new JoinedExpectation where any of the expectations need to +
or | @gobstones/gobstones-core - v0.4.6 +\ No newline at end of file +Function or
- or(...expectations): IFinishedExpectation
Create a new JoinedExpectation where any of the expectations need to have a
trueresult in order for the result of the joined one to be alsotrue. That is, an expectation that joins it's components with a logical or.Parameters
Rest...expectations: IFinishedExpectation[]A list of expectations where one need to be fulfilled in order to return
-trueas result.
Returns IFinishedExpectation
Returns IFinishedExpectation
Function deepEquals
- deep
Equals<T>(first, second): boolean Answer wether or not two elements are semantically equal, considering them +
deepEquals | @gobstones/gobstones-core - v0.4.6 +\ No newline at end of file +Function deepEquals
- deep
Equals<T>(first, second): boolean Answer wether or not two elements are semantically equal, considering them equal when they have the same type and all their internal elements are the same, or when they represent the same concept (two regular expressions that match the same string, two dates for the same moment, two sets with same @@ -36,4 +36,4 @@
Type Parameters
T
Parameters
first: T
The element to compare to.
second: T
The element to compare against.
Returns boolean
-trueif both elements are equal,falseotherwise.
- deep
Function deepStringAssign
- deep
String Assign<T>(target, ...sources): T It returns a copy of the target object, where its string keys has been overwritten with +
deepStringAssign | @gobstones/gobstones-core - v0.4.6 +\ No newline at end of file +Function deepStringAssign
- deep
String Assign<T>(target, ...sources): T It returns a copy of the target object, where its string keys has been overwritten with the corresponding keys of the sources objects, when they are present, recursively. If the same key appears in more than one of the source objects, the last one is used. If none of the objects has the key, or the key is not of string type, it is not changed. @@ -24,4 +24,4 @@
Type Parameters
T extends object
Parameters
target: T
An object that provides the default values for the fields of the result.
Rest...sources: Subset<T>[]A span parameter with objects possibly containing values to replace the defaults in string keys with strings as values.
-
Returns T
- deep
Returns T
Function flatten
- flatten<TTarget, TResult>(target, options?): TResult
Flatten the given object. +
flatten | @gobstones/gobstones-core - v0.4.6 +\ No newline at end of file +Function flatten
- flatten<TTarget, TResult>(target, options?): TResult
Flatten the given object. Given an object with nested elements, it returns an object that has been flattened, that is, where the keys are string that represent the nested route to follow in the original object to access the leaves.
@@ -10,4 +10,4 @@Additional options may be passed, such as which character is used as a delimiter, or the maximum depth level.
For an inverse operation see unflatten.
-
Function matrix
- matrix<T>(width, height, initialValueGenerator?): T[][]
Creates a two-dimensional matrix where all positions are filled using the given +
matrix | @gobstones/gobstones-core - v0.4.6 +\ No newline at end of file +Function matrix
- matrix<T>(width, height, initialValueGenerator?): T[][]
Creates a two-dimensional matrix where all positions are filled using the given generator.
Type Parameters
T
Parameters
width: number
The number of rows of the matrix
height: number
The number of columns of the matrix
@@ -7,4 +7,4 @@ the element to store the matrix at that position- (i, j): T
Parameters
i: number
j: number
Returns T
Returns T[][]
A
T[][]where T is the type of the elements in the matrix.Throws
Error if the width or the height given are zero or negative.
-
Function unflatten
- unflatten<TTarget, TResult>(target, options?): TResult
Un-Flatten the given object. +
unflatten | @gobstones/gobstones-core - v0.4.6 +\ No newline at end of file +Function unflatten
- unflatten<TTarget, TResult>(target, options?): TResult
Un-Flatten the given object. Given an object without nested elements, but whose keys represent paths in a nested elements object, return an object that has nested objects in it. This the reverse of flatten, in such a way that this complies.
@@ -9,4 +9,4 @@Additional options may be passed, such as which character is used as a delimiter, or the maximum depth level.
-
Function cli
- cli(options): CLIApp
Create a new CLI application.
+cli | @gobstones/gobstones-core - v0.4.6 +\ No newline at end of file +Function cli
- cli(options): CLIApp
Create a new CLI application.
Parameters
options: CLIAppOptions
The application options.
-
Returns CLIApp
The EventEmitter class is a minimal observer pattern class definition. +
- Preparing search index...
- The search index is not available
@gobstones/gobstones-core - v0.4.6Class EventEmitter<L>
The EventEmitter class is a minimal observer pattern class definition. Instances of this class can be created directly, by
@@ -83,4 +83,4 @@new EventEmitter()or it can be used as a base class for custom definitions that require support for this pattern in order to allow subscription to custom events.Type Parameters
U extends string | number | symbol
Parameters
event: U
The event to remove the observer from.
observer: L[U]
The observer to be removed.
map: Map<U, Set<L[U]>>
The map to unregister the event and observer.
-Returns void
Settings
Member Visibility
Theme
On This Page