A condition or condition-resolving function for pipe methods.
A closure that maps a given pipe item to a different type.
A subject function that yields the value in the AsyncPipe.
Value that can be used to uniquely identify a user.
Type alias for something that may or may not be wrapped in a promise.
Type alias for a function that resolves a canonical name to a canonical item, if one exists.
Subscribers that define multiple handler methods.
A validator function that takes the field key, the object value, and an object of contextual params.
Type alias for something that can be either a single constraint or a group of them.
SQL operator that is used to join two constraint clauses.
Type alias for a function that applies some constraints to a builder group.
SQL operator that appears in a constraint clause.
Base type for a constructor function.
Simple type alias for a callback to a container's onResolve method.
Type used to represent a value that can identify a factory in the container.
A value which can be escaped to be interpolated into an SQL query.
Object mapping string field names to EscapeValue items.
A closure that should be executed with the given event is fired.
Type structure for a single item in the global registry.
Enumeration of different HTTP verbs.
A key-value form of a given type.
Type name for the standalone localization helper function that can be passed around in lieu of the Locale service.
Type alias for something that may be undefined.
Type alias for something that is either an HTTP cookie, or undefined.
A valid key on a model.
Collection of keys of a set of models.
Type alias for a definition of a command-line option.
This can be either an instance of CLIOption or a string describing an option.
Possible SQL order-by clause directions.
Interface for storing the parts of a SQL order-by clause.
Type alias for a callback that accepts a typed argument.
An item that could represent a path.
A condition or condition-resolving function for pipe methods.
A single query row, as an object.
Type alias for an item that refers to a table in a database.
A closure that maps a given pipe item to an item of the same type.
A closure that maps a given pipe item to an item of the same type.
Type alias for possible values of a relation.
Type alias for a function that applies a route handler to the request. The goal is to transform RouteHandlers to ResolvedRouteHandler.
Type alias for an item that is a valid response object, or lack thereof.
Type alias for an item that defines a direct route handler.
A closure that takes a query and applies some scope to it.
Type alias describing some inflated session data.
Type annotation for a Queueable that should be pushed onto a queue.
A validator function that takes only the field key and the object value.
Type alias for an item that refers to a field on a table.
Type that identifies a value as a static class, even if it is not instantiable.
Type that identifies a value as a static class that instantiates to itself
Type of a basic subscriber function that handles completed events.
Type of a basic subscriber function that handles errors.
Type of a basic subscriber function.
Subscription to a behavior subject.
A DependencyKey, but typed
Object providing helpers for unsubscribing from a subscription.
A type alias denoting that a particular type has been validated.
All possible results of an attempted validation.
A set of validation rules that are applied to input objects on validators.
The keys of this object are deep-nested keys and can be used to validate nested properties.
For example, the key "user.links.*.url" refers to the "url" property of all objects in the "links" array on the "user" object on:
{
"user": {
"links": [
{
"url": "..."
},
{
"url": "..."
}
]
}
}
Useful type alias for all allowed validator function signatures.
Type representing a valid where operator.
Type representing the result of a where.
The reflection metadata key containing information about the model's fields.
Maps HTTP status code to default status message.
Export a singleton global registry for all code to share.
Exporting an instance here guarantees that all code that import it will get the same instance.
Register a class as a command-line Directive. The class must extend Directive.
Register a factory class directly with any created containers.
Decorator that maps the given property to a database column of the specified FieldType.
Mark the given class property to be injected by the container.
If a key
is specified, that DependencyKey will be injected.
Otherwise, the DependencyKey is inferred from the type annotation.
Parameter decorator to manually mark a parameter as being an injection target on injectable classes. This can be used to override the dependency key of a given parameter.
Class decorator that marks a class as injectable. When this is applied, dependency metadata for the constructors params is resolved and stored in metadata.
Decorator for relation methods on a Model implementation. Caches the relation instances between uses for the life of the model.
Class decorator that registers the class as a singleton instance in the global container.
Helper function for fetching a universal path relative to the app/
directory.
Apply the given mixin classes to the given constructor.
Apply the given where clause to the items and return those that match.
Helper function for fetching a universal path relative to the root of the application.
Format bytes as human-readable text.
Number of bytes.
True to use metric (SI) units, aka powers of 1000. False to use binary (IEC), aka powers of 1024.
Number of decimal places to display.
Get a deep-nested property on the given data object. This is NOT typesafe and is meant for internal use only.
Set a deep-nested property on the given object. This is NOT typesafe and is meant for internal use only.
Walks the given data object down to the given path, yielding subkeys. This is NOT typesafe and is intended for framework use only.
Make a deep copy of an object.
Helper function that creates a DehydratedStateResponseFactory.
Helper function that resolves and infers environment variable values.
If none is found, returns defaultValue
.
Helper to create a new ErrorResponseFactory, with the given HTTP status and output format.
Helper function that creates a FileResponseFactory for the given path.
Builds a middleware function that validates a request's input against the given form request class and registers the FormRequest class into the request container.
Retrieve a collection of ModelField metadata from the given model.
A typescript-compatible version of Object.hasOwnProperty.
Helper function that creates a new HTMLResponseFactory.
Helper that generates a new HTTPErrorResponseFactory given the HTTP status and message.
Given a string of a value, try to infer the JavaScript type.
Given a FieldType, get the inverse (that is, the code-form name).
Returns true if the given object is bindable.
boolean
Function that checks whether a given value satisfies the CanonicalReceiver interface.
Returns true if the given object is a valid ConstraintGroup.
Returns true if the given object is a valid ConstraintItem
Returns true if the given item is a valid HTTP verb.
Returns true if the given value is instantiable.
Returns true if the given value is instantiable and, once instantiated, will create an instance of the given static class.
Returns true if the given value is valid JSON.
Returns true if the given object can be JSON serialized.
boolean
Simple helper method to verify that a key is a keyof some object.
Returns true if the given object is a log message.
boolean
Returns true if the given element is a logging level.
boolean
Truth function that returns true if an object implements the same interface as Queueable. This is done in case some external library needs to be incorporated as the base class for a Queueable, and cannot be made to extend Queueable.
Returns true if the parameter is a static class.
Helper function to create a new JSONResponseFactory of the given value.
Get the path to the root of the @extollo/lib package.
Create an array of key-value pairs for the keys in a uniform object.
If string
is less than length
characters long, add however many padWith
characters
are necessary to make up the difference evenly split between the beginning and end of the string.
If string
is less than length
characters long, add however many padWith
characters
are necessary to make up the difference to the BEGINNING of the string.
If string
is less than length
characters long, add however many padWith
characters
are necessary to make up the difference to the END of the string.
Helper function that creates a new StringResponseFactory for the given string value.
Treat the value as raw SQL that can be injected directly into a query. This is dangerous and should NEVER be used to wrap user input.
Helper function to create a new RedirectResponseFactory to the given destination.
Helper function that creates a new ViewResponseFactory that redirects the user to the given URL.
Helper function to create a new RouteResponseFactory to the given destination.
Set the collection of ModelField metadata as the field data for the given model.
Truth function that returns true if the given object is Queueable and wants to be pushed onto the queue.
Get a route handler that serves a directory as static files.
Convert a string to PascalCase.
Helper function to create a new TemporaryRedirectResponseFactory to the given destination.
Given an inferred value, try to convert back to the string form.
Create a new UniversalPath from the given path-like segments.
Get a universally-unique ID string.
string
Helper function that creates a new ViewResponseFactory to render the given view with the specified data.
Walk recursively over entries in a directory.
Right now the types are kinda weird for async iterables. This is like an async IterableIterable that resolves a string or another IterableIterable of the same type.
Hence why it's separate from the UniversalPath class.
Returns true if the given item satisfies the given where clause.
boolean
Subscribe to a promise with a timeout.
timeout in milliseconds
the promise to subscribe to
extollo (v. latin) - to lift up, to elevate
Extollo is a free & libre application framework in TypeScript.
Type associating search items with a key.