@augment-vir/common 13.2.1 → 13.2.2

package/dist/esm/augments/runtime-type-of.d.ts

@@ -1,20 +0,0 @@
-import { AnyFunction } from './function';
-declare function rawGetTypeOf(x: any): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
-type RawTypeOf = ReturnType<typeof rawGetTypeOf>;
-export type RuntimeTypeOf = RawTypeOf | 'array';
-export type RuntimeTypeOfMapping = {
-    array: any[] | ReadonlyArray<any>;
-    bigint: bigint;
-    boolean: boolean;
-    function: AnyFunction | Readonly<AnyFunction>;
-    number: number;
-    object: Record<PropertyKey, unknown> | Readonly<Record<PropertyKey, unknown>>;
-    string: string;
-    symbol: symbol;
-    undefined: undefined;
-};
-export declare function getRuntimeTypeOf(input: unknown): RuntimeTypeOf;
-export declare function isRuntimeTypeOf<T extends RuntimeTypeOf>(input: unknown, testType: T): input is RuntimeTypeOfMapping[T];
-export declare function assertRuntimeTypeOf<T extends RuntimeTypeOf>(input: unknown, testType: T, inputName: string): asserts input is RuntimeTypeOfMapping[T];
-export {};
-//# sourceMappingURL=runtime-type-of.d.ts.map

package/dist/esm/augments/string/url.d.ts

@@ -1,8 +0,0 @@
-/**
- * Joins all given arguments together as if they were parts of a URL. Preserves trailing slashes and
- * removes consecutive slashes in the path. This also encodes each URL part.
- *
- * @example: joinToUrl('https://example.com', 'path1', 'path2/', '/path3/') === 'https://example.com/path1/path2/path3/'
- */
-export declare function joinUrlParts(...urlParts: ReadonlyArray<string>): string;
-//# sourceMappingURL=url.d.ts.map

package/dist/esm/augments/string/uuid.d.ts

@@ -1,2 +0,0 @@
-export declare function isUuid(maybeUuid: string): boolean;
-//# sourceMappingURL=uuid.d.ts.map

package/dist/esm/augments/truncate-number.d.ts

@@ -1,20 +0,0 @@
-/**
- * This truncates a number such that is will at a max have 6 characters including suffix, decimal
- * point, or comma.
- *
- * Default suffixes are:
- *
- *     'k', // thousand
- *     'M', // million
- *     'B', // billion
- *     'T', // trillion
- *     'P', // peta-, quadrillion
- *     'E', // exa- quintillion
- *     'Z', // zetta- sextillion
- *     'Y', // yotta- septillion
- */
-export declare function truncateNumber(originalValue: Readonly<unknown>, { customSuffixes, maxLength, }?: Partial<{
-    customSuffixes: ReadonlyArray<string> | undefined;
-    maxLength: number | undefined;
-}>): string;
-//# sourceMappingURL=truncate-number.d.ts.map

package/dist/esm/augments/tuple.d.ts

@@ -1,9 +0,0 @@
-export type Tuple<ArrayElementGeneric, LengthGeneric extends number> = LengthGeneric extends LengthGeneric ? number extends LengthGeneric ? ArrayElementGeneric[] : _TupleOf<ArrayElementGeneric, LengthGeneric, []> : never;
-type _TupleOf<ArrayElementGeneric, LengthGeneric extends number, FullArrayGeneric extends unknown[]> = FullArrayGeneric['length'] extends LengthGeneric ? FullArrayGeneric : _TupleOf<ArrayElementGeneric, LengthGeneric, [ArrayElementGeneric, ...FullArrayGeneric]>;
-export type AtLeastTuple<ArrayElementGeneric, LengthGeneric extends number> = readonly [
-    ...Tuple<ArrayElementGeneric, LengthGeneric>,
-    ...(ArrayElementGeneric | undefined)[]
-];
-export declare function isLengthAtLeast<ArrayElementGeneric, LengthGeneric extends number>(array: ReadonlyArray<ArrayElementGeneric | undefined>, length: LengthGeneric): array is AtLeastTuple<ArrayElementGeneric, LengthGeneric>;
-export {};
-//# sourceMappingURL=tuple.d.ts.map

package/dist/esm/augments/type.d.ts

@@ -1,60 +0,0 @@
-import { Except, Simplify } from 'type-fest';
-/** Makes all properties in an object writable. This is the opposite of Readonly<> */
-export type Writeable<T> = {
-    -readonly [P in keyof T]: T[P];
-};
-/** Makes all property values in an object also readonly. Can cause issues on primitive. */
-export type DeepWriteable<T> = {
-    -readonly [P in keyof T]: DeepWriteable<T[P]>;
-};
-/** Replace properties in T with properties in U. */
-export type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U;
-/** Extract the element type out of an array type. */
-export type ArrayElement<ArrayType extends ReadonlyArray<any>> = ArrayType[number];
-/**
- * Same as the Required<> built-in type helper but this requires that each property be present and
- * be not null.
- */
-export type RequiredAndNotNull<T> = {
-    [P in keyof T]-?: NonNullable<T[P]>;
-};
-export type SetOptionalAndNullable<OriginalObjectGeneric, OptionalKeysGeneric extends keyof OriginalObjectGeneric> = Simplify<Except<OriginalObjectGeneric, OptionalKeysGeneric> & {
-    [PropKey in OptionalKeysGeneric]?: OriginalObjectGeneric[PropKey] | null | undefined;
-}>;
-/** Require only a subset of object properties. */
-export type RequiredBy<T, K extends keyof T> = Overwrite<T, Required<Pick<T, K>>>;
-export declare function makeWritable<T>(input: T): Writeable<T>;
-export declare function makeReadonly<T>(input: T): Readonly<T>;
-/**
- * Require only a subset of object properties and require that they be not null. This is
- * particularly useful in conjunction with the "exactOptionalPropertyTypes" tsconfig flag.
- */
-export type RequiredAndNotNullBy<T, K extends keyof T> = Omit<T, K> & Required<{
-    [PropertyName in K]: NonNullable<T[PropertyName]>;
-}>;
-/** If type T = type U, then type Y. Else type N. */
-export type IfEquals<T, U, Y = unknown, N = never> = (<G>() => G extends T ? 1 : 2) extends <G>() => G extends U ? 1 : 2 ? Y : N;
-/**
- * This function returns another function that simply returns whatever input it's given. However, it
- * also checks that the input matches the original wrapNarrowTypeWithTypeCheck's generic, while
- * maintaining strict "const" like typing.
- *
- * Use like this: wrapNarrowTypeWithTypeCheck<EnforcedTypeHere>()(valueToEnforceTypeOn as const)
- *
- * Sometimes "as const" isn't required, usually it is for any object or array though.
- */
-export declare function wrapNarrowTypeWithTypeCheck<P>(): <T extends P>(input: T) => Readonly<T>;
-/**
- * This type helper is useful for forcing function generics to be explicitly provided, rather than
- * inferring them from the given inputs. See the test file for examples.
- */
-export type NoInfer<T> = [T][T extends any ? 0 : never];
-/**
- * This is a type helper that ensures the given input matches the given generic type. The generic is
- * setup in such a way that if it is omitted (which is typically allowed in TypeScript, resulting in
- * the generic being inferred from the inputs), there will actually be a type error. This forces
- * each usage of this function to explicitly specify the generic, thus giving us type safety for the
- * input.
- */
-export declare function ensureType<ExpectedType = never>(input: NoInfer<ExpectedType>): NoInfer<ExpectedType>;
-//# sourceMappingURL=type.d.ts.map

package/dist/esm/index.d.ts

@@ -1,32 +0,0 @@
-export * from './augments/ansi';
-export * from './augments/array';
-export * from './augments/async';
-export * from './augments/common-number';
-export * from './augments/common-string';
-export * from './augments/date/date';
-export * from './augments/date/relative-date';
-export * from './augments/environment';
-export * from './augments/error';
-export * from './augments/function';
-export * from './augments/json';
-export * from './augments/json-compatible';
-export * from './augments/object/enum';
-export * from './augments/object/filter-object';
-export * from './augments/object/has-key';
-export * from './augments/object/jsonify';
-export * from './augments/object/map-object';
-export * from './augments/object/matches-object-shape';
-export * from './augments/object/nested-keys';
-export * from './augments/object/object';
-export * from './augments/object/object-entries';
-export * from './augments/object/pick-deep';
-export * from './augments/object/typed-has-property';
-export * from './augments/promise';
-export * from './augments/regexp';
-export * from './augments/runtime-type-of';
-export * from './augments/string/url';
-export * from './augments/string/uuid';
-export * from './augments/truncate-number';
-export * from './augments/tuple';
-export * from './augments/type';
-//# sourceMappingURL=index.d.ts.map