Nexus Core

This package contains a collection of modules that provide a common functionality without substantial external dependencies. Generally, the modules in this package are not intended to be used directly, but rather are used internally within other Nexus packages.

Core modules do not require a specific JavaScript runtime, and can be used in Node.js, browser, or Web Worker environments. For modules that require Node.js-specific functionality, see @isp.nexus/sdk.

Environment

Interface, Type alias, Variable, Function	Description
OptionalEnvironment	A record containing all of the optional environment variables for Open ISP.
EnvironmentKeys	All recognized environment keys.
EnvironmentName	A tuple of all of the recognized environment names.
EnvironmentRecordInput	A generic environment record without any specific keys.
OptionalEnvironmentKey	Optional environment keys.
PrivateEnvironmentKeys	Environment keys private to the application.
PublicEnvironmentKeys	Environment keys safe to reveal to the public.
isEnvironmentRecordInput	Type-predicate for determining if a given object seems to be an environment record.

Identifier

Type alias, Function	Description
UUIDLiteral	A UUID string, used for identifying entities.
createOrParseUUIDv7	Attempts to parse a UUID from a string or returns a new UUID.
formatUUID	Format a UUID as a string.
uuidV5	Generate a UUID v5.
uuidV7	Generate a UUID v7.

Nexus

Variable	Description
ISPNexusSchemaURL	URL to the ISP Nexus schema store.

Object

Type alias, Function	Description
NonNullableObject	Type-helper to remove nullability from an object's properties.
isIterable	Type-predicate for checking if a value is iterable.
isRecordLike	Type-predicate for checking if a value appears to be a record, i.e. an object that is not an array.
omitNullable	Given an object, returns a new object with all nullable properties removed.

Other

Enumeration, Class, Interface, Type alias, Variable, Function	Description
ModelIDLength	-
TemporalColumnName	-
UserAgent	Common user agent strings.
APIClient	A base class for API clients used in ISP Nexus.
JSONSet	JSON-seralizable set.
PredicateError	Error thrown when a predicate fails.
SetTuple	Set constructor that only accepts string values.
APIClientConfig	Configuration for an API client.
ExperimentalSetMethods	-
IndexedIterable	Iterable that can be checked for the existence of a member.
IRuntimeLogger	Logger with browser methods, as well as async disposability.
RequiredEnvironment	A record containing all of the required environment variables for . Absence of any of these variables will result in a startup error.
ResponseContainer	A response container, wrapping the actual response body.
TemporalProperties	Common temporal properties for database entities.
EnvironmentRecord	A record containing all of the environment variables for ISP Nexus.
ExtractJSON	JSON serialize type.
ExtractJSONProperties	JSON serialize objects (not including arrays) and classes.
ExtractResponseBodyData	Type-helper to recursively pluck the data property from a response body.
ExtractResponseData	Type-helper to pluck the response body, possibly from within an Axios response.
InferTupleMember	Type-helper for extracting the value type from a constant set.
ISPNexusPackage	Valid package names for ISP Nexus.
ISPNexusPackageFn	Type-signature for a package-scoped function.
ISPNexusSchemaURL	-
NumericProperties	Extracts the property keys of an object that are of type number.
PickJSON	Pick JSON properties from an object.
PrivateEnvironment	Subset environment kept private.
PrivateEnvironmentKey	Private environment keys.
PublicEnvironment	Subset environment safe to reveal to the public.
PublicEnvironmentKey	Public environment keys.
RequiredEnvironmentKey	Required environment keys.
ResponseLike	-
SHA3Input	-
SHA3Seed	-
StringKeyOf	Type-utility for extracting the string keys of an object.
WithExperimentalSetMethods	-
EnvironmentKeys	ISP Nexus recognized environment keys.
EnvironmentNames	Standard Node.js runtime environment values.
ISPNexusPackages	Packages used in the ISP Nexus mono-repo.
NIL_UUID	A placeholder UUID for empty values.
OptionalEnvironmentKey	A tuple of all of the optional environment keys.
RequiredEnvironmentKeys	A tuple of all of the required environment keys.
TemporalColumnNames	All temporal column names. Used for SQL select queries.
TemporalColumnOptions	TypeORM column options for temporal properties.
assertEnvironmentRecordPresent	Asserts that the given input contains all of the required environment keys.
assertOptionalKeyPresent	Runtime assertion that an optional key is present.
checkConnectivity	-
continueIf	Resolves promise if condition is truthy, otherwise throws an error.
delegateAxiosError	Delegate Axios errors to an appropriate error handler.
isIndexedIterable	Type-predicate for checking if an member within an iterable can be checked for existence.
isSetLike	Type-predicate for checking if a value is a Set-like object.
isUniformlyCased	Predicate to determine if a given string is uniformly cased, i.e. all uppercase or all lowercase.
isUUIDBytes	-
iterateInParallel	Convenience function to await an async iterable.
JSONSchemaID	-
normalizeSHASeeds	-
pick	-
pickJSON	-
pluckResponseData	Helper function to recursively pluck the data property from a response body.
simpleSHA3	-
smartCamelCase	Converts a name to camelCase, unless the name is already in all caps.
smartCapitalCase	Capitalizes a string, unless the string is uniformly cased, or an email address.
smartSnakeCase	Converts a name to snake_case, unless the name is already in all caps.
sumOf	Given an iterable of objects, returns the sum of the specified property.
supressErrors	Something like an identity function, but swallows errors and returns null.
take	Given an iterable, returns an array of arrays of the specified size.
takeInParallel	Given an iterable collection, returns an async iterable, executing the callback on each batch.
throwIf	Resolves promise if condition is falsy, otherwise throws an error.
tryParsingJSON	Given serialized JSON, attempt to parse it.
tuple	Creates a readonly tuple-like set of values.
waitForTimeout	Promise-based sleep function.

Polyfill

Interface	Description
SetLike	A type representing a Set compatible object.

Temporal

Type alias, Function	Description
ISODateTimeString	A string type to indicate ISO 8601 formatted content.
unserializeDate	Unserialize a date string into a Date object.

Type Guard

Function	Description
isIterable	Type-predicate for checking if a value is iterable.
isRecordLike	Type-predicate for checking if a value appears to be a record, i.e. an object that is not an array.

UUID

Function	Description
isUUID	Type-predicate to check if a string is a valid UUID.