@joookiwi/type 1.0.0

package/src/numeric (-1).ts

@@ -0,0 +1,88 @@
+/*******************************************************************************
+ Copyright (c) 2023-2024. Jonathan Bédard ~ JóôòKiwi
+
+ This project is free to use.
+ All the right is reserved to the author of this project.
+ ******************************************************************************/
+
+/**
+ * A type-alias for <b>-1</b> (as a {@link Number} or a {@link BigInt})
+ * as a primitive
+ *
+ * @see Numeric
+ * @see MinusOneNumber
+ * @see MinusOneBigInt
+ */
+export type MinusOne<T extends | -1 | -1n = | -1 | -1n, > = T
+/**
+ * A type-alias for the {@link Number} <b>-1</b>
+ * as a primitive
+ *
+ * @see MinusOne
+ */
+export type MinusOneNumber<T extends -1 = -1, > = T
+/**
+ * A type-alias for the {@link BigInt} <b>-1</b>
+ * as a primitive
+ *
+ * @see MinusOne
+ */
+export type MinusOneBigInt<T extends -1n = -1n, > = T
+
+/**
+ * A type-alias for <b>-1</b> (as a {@link Number} or a {@link BigInt})
+ * in a {@link String} template
+ *
+ * @see MinusOne
+ * @see MinusOneNumber
+ * @see MinusOneBigInt
+ * @see Template
+ * @see TemplateOrMinusOne
+ * @see NumericTemplate
+ * @see NumberTemplate
+ * @see BigIntTemplate
+ */
+export type MinusOneTemplate<T extends | -1 | -1n = | -1 | -1n, > = `${T}`
+
+/**
+ * A type-alias for <b>-1</b> (as a {@link Number} or a {@link BigInt})
+ * as a primitive or in a {@link String} template
+ *
+ * @see MinusOne
+ * @see MinusOneNumber
+ * @see MinusOneBigInt
+ * @see Template
+ * @see MinusOneTemplate
+ * @see TemplateOrMinusOneNumber
+ * @see TemplateOrMinusOneBigInt
+ * @see TemplateOrNumeric
+ * @see TemplateOrNumber
+ * @see TemplateOrBigInt
+ */
+export type TemplateOrMinusOne<T extends | -1 | -1n = | -1 | -1n, > = | T | `${T}`
+/**
+ * A type-alias for the {@link Number} <b>-1</b>
+ * as a primitive or in a {@link String} template
+ *
+ * @see MinusOne
+ * @see MinusOneNumber
+ * @see Template
+ * @see MinusOneTemplate
+ * @see TemplateOrMinusOne
+ * @see TemplateOrNumeric
+ * @see TemplateOrNumber
+ */
+export type TemplateOrMinusOneNumber<T extends -1 = -1, > = | T | `${T}`
+/**
+ * A type-alias for the {@link BigInt} <b>-1</b>
+ * as a primitive or in a {@link String} template
+ *
+ * @see MinusOne
+ * @see MinusOneBigInt
+ * @see Template
+ * @see MinusOneTemplate
+ * @see TemplateOrMinusOne
+ * @see TemplateOrNumeric
+ * @see TemplateOrBigInt
+ */
+export type TemplateOrMinusOneBigInt<T extends -1n = -1n, > = | T | `${T}`

package/src/numeric (0).ts

@@ -0,0 +1,90 @@
+/*******************************************************************************
+ Copyright (c) 2023-2024. Jonathan Bédard ~ JóôòKiwi
+
+ This project is free to use.
+ All the right is reserved to the author of this project.
+ ******************************************************************************/
+
+/**
+ * A type-alias for <b>0</b> (as a {@link Number} or a {@link BigInt})
+ * as a primitive
+ *
+ * @see Numeric
+ * @see MinusOneNumber
+ * @see MinusOneBigInt
+ */
+export type Zero<T extends | 0 | 0n = | 0 | 0n, > = T
+/**
+ * A type-alias for the {@link Number} <b>0</b>
+ * as a primitive
+ *
+ * @see Zero
+ */
+export type ZeroNumber<T extends 0 = 0, > = T
+/**
+ * A type-alias for the {@link BigInt} <b>0</b>
+ * as a primitive
+ *
+ * @see Zero
+ */
+export type ZeroBigInt<T extends 0n = 0n, > = T
+
+/**
+ * A type-alias for <b>0</b> (as a {@link Number} or a {@link BigInt})
+ * in a {@link String} template
+ *
+ * @see Zero
+ * @see ZeroNumber
+ * @see ZeroBigInt
+ * @see Template
+ * @see TemplateOrZero
+ * @see TemplateOrZeroNumber
+ * @see TemplateOrZeroBigInt
+ * @see NumericTemplate
+ * @see NumberTemplate
+ * @see BigIntTemplate
+ */
+export type ZeroTemplate<T extends | 0 | 0n = | 0 | 0n, > = `${T}`
+
+/**
+ * A type-alias for <b>0</b> (as a {@link Number} or a {@link BigInt})
+ * as a primitive or in a {@link String} template
+ *
+ * @see Zero
+ * @see ZeroNumber
+ * @see ZeroBigInt
+ * @see Template
+ * @see ZeroTemplate
+ * @see TemplateOrZeroNumber
+ * @see TemplateOrZeroBigInt
+ * @see TemplateOrNumeric
+ * @see TemplateOrNumber
+ * @see TemplateOrBigInt
+ */
+export type TemplateOrZero<T extends | 0 | 0n = | 0 | 0n, > = | T | `${T}`
+/**
+ * A type-alias for the {@link Number} <b>0</b>
+ * as a primitive or in a {@link String} template
+ *
+ * @see Zero
+ * @see ZeroNumber
+ * @see Template
+ * @see ZeroTemplate
+ * @see TemplateOrZero
+ * @see TemplateOrNumeric
+ * @see TemplateOrNumber
+ */
+export type TemplateOrZeroNumber<T extends 0 = 0, > = | T | `${T}`
+/**
+ * A type-alias for the {@link BigInt} <b>0</b>
+ * as a primitive or in a {@link String} template
+ *
+ * @see Zero
+ * @see ZeroBigInt
+ * @see Template
+ * @see ZeroTemplate
+ * @see TemplateOrZero
+ * @see TemplateOrNumeric
+ * @see TemplateOrBigInt
+ */
+export type TemplateOrZeroBigInt<T extends 0n = 0n, > = | T | `${T}`

package/src/numeric (1).ts

@@ -0,0 +1,90 @@
+/*******************************************************************************
+ Copyright (c) 2023-2024. Jonathan Bédard ~ JóôòKiwi
+
+ This project is free to use.
+ All the right is reserved to the author of this project.
+ ******************************************************************************/
+
+/**
+ * A type-alias for <b>1</b> (as a {@link Number} or a {@link BigInt})
+ * as a primitive
+ *
+ * @see Numeric
+ * @see MinusOneNumber
+ * @see MinusOneBigInt
+ */
+export type One<T extends | 1 | 1n = | 1 | 1n, > = T
+/**
+ * A type-alias for the {@link Number} <b>1</b>
+ * as a primitive
+ *
+ * @see One
+ */
+export type OneNumber<T extends 1 = 1, > = T
+/**
+ * A type-alias for the {@link BigInt} <b>1</b>
+ * as a primitive
+ *
+ * @see One
+ */
+export type OneBigInt<T extends 1n = 1n, > = T
+
+/**
+ * A type-alias for <b>1</b> (as a {@link Number} or a {@link BigInt})
+ * in a {@link String} template
+ *
+ * @see One
+ * @see OneNumber
+ * @see OneBigInt
+ * @see Template
+ * @see TemplateOrOne
+ * @see TemplateOrOneNumber
+ * @see TemplateOrOneBigInt
+ * @see NumberTemplate
+ * @see BigIntTemplate
+ * @see NumericTemplate
+ */
+export type OneTemplate<T extends | 1 | 1n = | 1 | 1n, > = `${T}`
+
+/**
+ * A type-alias for <b>1</b> (as a {@link Number} or a {@link BigInt})
+ * as a primitive or in a {@link String} template
+ *
+ * @see One
+ * @see OneNumber
+ * @see OneBigInt
+ * @see Template
+ * @see OneTemplate
+ * @see TemplateOrOneNumber
+ * @see TemplateOrOneBigInt
+ * @see TemplateOrNumeric
+ * @see TemplateOrNumber
+ * @see TemplateOrBigInt
+ */
+export type TemplateOrOne<T extends | 1 | 1n = | 1 | 1n, > = | T | `${T}`
+/**
+ * A type-alias for the {@link Number} <b>1</b>
+ * as a primitive or in a {@link String} template
+ *
+ * @see One
+ * @see OneBigInt
+ * @see Template
+ * @see OneTemplate
+ * @see TemplateOrOne
+ * @see TemplateOrNumeric
+ * @see TemplateOrNumber
+ */
+export type TemplateOrOneNumber<T extends 1 = 1, > = | T | `${T}`
+/**
+ * A type-alias for the {@link BigInt} <b>1</b>
+ * as a primitive or in a {@link String} template
+ *
+ * @see One
+ * @see OneBigInt
+ * @see Template
+ * @see OneTemplate
+ * @see TemplateOrOne
+ * @see TemplateOrNumeric
+ * @see TemplateOrBigInt
+ */
+export type TemplateOrOneBigInt<T extends 1n = 1n, > = | T | `${T}`

package/src/numeric (2).ts

@@ -0,0 +1,86 @@
+/*******************************************************************************
+ Copyright (c) 2023-2024. Jonathan Bédard ~ JóôòKiwi
+
+ This project is free to use.
+ All the right is reserved to the author of this project.
+ ******************************************************************************/
+
+/**
+ * A type-alias for <b>2</b> (as a {@link Number} or a {@link BigInt})
+ * as a primitive
+ *
+ * @see Numeric
+ * @see MinusTwoNumber
+ * @see MinusTwoBigInt
+ */
+export type Two<T extends | 2 | 2n = | 2 | 2n, > = T
+/**
+ * A type-alias for the {@link Number} <b>2</b>
+ * as a primitive
+ *
+ * @see Two
+ */
+export type TwoNumber<T extends 2 = 2, > = T
+/**
+ * A type-alias for the {@link BigInt} <b>2</b>
+ * as a primitive
+ *
+ * @see Two
+ */
+export type TwoBigInt<T extends 2n = 2n, > = T
+
+/**
+ * A type-alias for <b>2</b> (as a {@link Number} or a {@link BigInt})
+ * in a {@link String} template
+ *
+ * @see Two
+ * @see TwoNumber
+ * @see TwoBigInt
+ * @see Template
+ * @see TemplateOrTwo
+ * @see NumberTemplate
+ * @see BigIntTemplate
+ * @see NumericTemplate
+ */
+export type TwoTemplate<T extends | 2 | 2n = | 2 | 2n, > = `${T}`
+
+/**
+ * A type-alias for <b>2</b> (as a {@link Number} or a {@link BigInt})
+ * as a primitive or in a {@link String} template
+ *
+ * @see Two
+ * @see TwoNumber
+ * @see TwoBigInt
+ * @see Template
+ * @see TwoTemplate
+ * @see TemplateOrTwoNumber
+ * @see TemplateOrTwoBigInt
+ * @see TemplateOrNumeric
+ * @see TemplateOrNumber
+ * @see TemplateOrBigInt
+ */
+export type TemplateOrTwo<T extends | 2 | 2n = | 2 | 2n, > = | T | `${T}`
+/**
+ * A type-alias for the {@link Number} <b>2</b>
+ * as a primitive or in a {@link String} template
+ *
+ * @see Two
+ * @see TwoNumber
+ * @see Template
+ * @see TwoTemplate
+ * @see TemplateOrTwo
+ * @see TemplateOrNumber
+ */
+export type TemplateOrTwoNumber<T extends 2 = 2, > = | T | `${T}`
+/**
+ * A type-alias for the {@link BigInt} <b>2</b>
+ * as a primitive or in a {@link String} template
+ *
+ * @see Two
+ * @see TwoBigInt
+ * @see Template
+ * @see TwoTemplate
+ * @see TemplateOrTwo
+ * @see TemplateOrBigInt
+ */
+export type TemplateOrTwoBigInt<T extends 2n = 2n, > = | T | `${T}`

package/src/numeric (bigint).ts

@@ -0,0 +1,44 @@
+/*******************************************************************************
+ Copyright (c) 2023-2024. Jonathan Bédard ~ JóôòKiwi
+
+ This project is free to use.
+ All the right is reserved to the author of this project.
+ ******************************************************************************/
+
+/** A type-alias for a {@link BigInt}
+ * in a {@link String} template
+ *
+ * @see Template
+ * @see NumericTemplate
+ */
+export type BigIntTemplate<T extends bigint = bigint, > = `${T}`
+
+/**
+ * A type-alias for a {@link BigInt}
+ * as a primitive or in a {@link String} template
+ *
+ * @see Template
+ * @see TemplateOrNumeric
+ * @see TemplateOrBigIntOrObject
+ */
+export type TemplateOrBigInt<T extends bigint = bigint, > = | T | `${T}`
+
+/**
+ * A type-alias for a {@link BigInt}
+ * as a primitive or an object
+ *
+ * @see NumericOrObject
+ * @see TemplateOrBigIntOrObject
+ */
+export type BigIntOrObject<T extends bigint = bigint, > = | T | BigInt
+
+/**
+ * A type-alias for a {@link BigInt}
+ * as a primitive, an object or in a {@link String} template
+ *
+ * @see Template
+ * @see TemplateOrBigInt
+ * @see BigIntOrObject
+ * @see TemplateOrNumericOrObject
+ */
+export type TemplateOrBigIntOrObject<T extends bigint = bigint, > = | T | BigInt | `${T}`

package/src/numeric (number).ts

@@ -0,0 +1,45 @@
+/*******************************************************************************
+ Copyright (c) 2023-2024. Jonathan Bédard ~ JóôòKiwi
+
+ This project is free to use.
+ All the right is reserved to the author of this project.
+ ******************************************************************************/
+
+/**
+ * A type-alias for a {@link Number}
+ * in a {@link String} template
+ *
+ * @see Template
+ * @see NumericTemplate
+ */
+export type NumberTemplate<T extends number = number, > = `${T}`
+
+/**
+ * A type-alias for a {@link Number}
+ * as a primitive or in a {@link String} template
+ *
+ * @see Template
+ * @see TemplateOrNumeric
+ * @see TemplateOrNumberOrObject
+ */
+export type TemplateOrNumber<T extends number = number, > = | T | `${T}`
+
+/**
+ * A type-alias for a {@link Number}
+ * as a primitive or an object
+ *
+ * @see NumericOrObject
+ * @see TemplateOrNumberOrObject
+ */
+export type NumberOrObject<T extends number = number, > = | T | Number
+
+/**
+ * A type-alias for a {@link Number}
+ * as a primitive, an object or in a {@link String} template
+ *
+ * @see Template
+ * @see TemplateOrNumber
+ * @see NumberOrObject
+ * @see TemplateOrNumericOrObject
+ */
+export type TemplateOrNumberOrObject<T extends number = number, > = | T | Number | `${T}`

package/src/numeric.ts

@@ -0,0 +1,55 @@
+/*******************************************************************************
+ Copyright (c) 2023-2024. Jonathan Bédard ~ JóôòKiwi
+
+ This project is free to use.
+ All the right is reserved to the author of this project.
+ ******************************************************************************/
+
+/** A type-alias for a {@link Number} or a {@link BigInt} as a primitive */
+export type Numeric<T extends | number | bigint = | number | bigint, > = T
+
+/**
+ * A type-alias for a value ({@link Number} or {@link BigInt})
+ * in a {@link String} template
+ *
+ * @see Numeric
+ * @see Template
+ * @see NumberTemplate
+ * @see BigIntTemplate
+ */
+export type NumericTemplate<T extends Numeric = Numeric, > = `${T}`
+
+/**
+ * A type-alias for a value ({@link Number} or {@link BigInt})
+ * as a primitive or in a {@link String} template
+ *
+ * @see Numeric
+ * @see Template
+ * @see TemplateOrNumber
+ * @see TemplateOrBigInt
+ * @see TemplateOrNumericOrObject
+ */
+export type TemplateOrNumeric<T extends Numeric = Numeric, > = | T | `${T}`
+
+/**
+ * A type-alias for a value ({@link Number} or {@link BigInt})
+ * as a primitive or an object
+ *
+ * @see Numeric
+ * @see NumberOrObject
+ * @see BigIntOrObject
+ * @see TemplateOrNumericOrObject
+ */
+export type NumericOrObject<T extends Numeric = Numeric, > = | T | Number | BigInt
+
+/**
+ * A type-alias for a value ({@link Number} or {@link BigInt})
+ * as a primitive, an object or in a {@link String} template
+ *
+ * @see Numeric
+ * @see Template
+ * @see TemplateOrNumberOrObject
+ * @see TemplateOrBigIntOrObject
+ * @see TemplateOrNumeric
+ */
+export type TemplateOrNumericOrObject<T extends Numeric = Numeric, > = | T | Number | BigInt | `${T}`

package/src/string (individual).ts

@@ -0,0 +1,35 @@
+/*******************************************************************************
+ Copyright (c) 2023-2024. Jonathan Bédard ~ JóôòKiwi
+
+ This project is free to use.
+ All the right is reserved to the author of this project.
+ ******************************************************************************/
+
+/** A type-alias for the {@link Boolean} <b>true</b> as a {@link String} */
+export type TrueString = "true"
+/** A type-alias for the {@link Boolean} <b>false</b> as a {@link String} */
+export type FalseString = "false"
+
+/** A type-alias for the {@link Number} <b>-1</b> as a {@link String} */
+export type MinusOneString = "-1"
+/** A type-alias for the {@link Number} <b>0</b> as a {@link String Character} */
+export type ZeroString = '0'
+/** A type-alias for the {@link Number} <b>1</b> as a {@link String Character} */
+export type OneString = '1'
+/** A type-alias for the {@link Number} <b>2</b> as a {@link String Character} */
+export type TwoString = '2'
+
+/** A type-alias for the "space" {@link String character} */
+export type Space = ' '
+/** A type-alias for the "tabulation" (\t) {@link String character} */
+export type Tabulation = '\t'
+/** A type-alias for the "enter" (\n) {@link String character} */
+export type Enter = '\n'
+/** A type-alias for the "comma" {@link String character} */
+export type Comma = ','
+/** A type-alias for the "point" {@link String character} */
+export type Point = '.'
+/** A type-alias for the "infinity" {@link String character} */
+export type InfinityString = '∞'
+/** A type-alias for the "suspension point" {@link String character} */
+export type SuspensionPoint = '…'

package/src/string.ts

@@ -0,0 +1,59 @@
+/*******************************************************************************
+ Copyright (c) 2023-2024. Jonathan Bédard ~ JóôòKiwi
+
+ This project is free to use.
+ All the right is reserved to the author of this project.
+ ******************************************************************************/
+
+/**
+ * A type-alias for a value
+ * ({@link String}, {@link Boolean} {@link Number}, {@link BigInt}, <b>null</b> or <b>undefined</b>)
+ * in a {@link String} template
+ */
+export type Template<T extends | string | boolean | number | bigint | null | undefined = | string | boolean | number | bigint | null | undefined, > = `${T}`
+/** A type-alias for a {@link String} as a primitive or an object */
+export type StringOrObject<T extends string = string, > = | T | String
+
+/**
+ * The possible hint received from javascript interpolation & conversion
+ *
+ * @see Symbol.toPrimitive
+ */
+export type PossiblePrimitiveHint = "string" | "number" | "default"
+/**
+ * The possible edge case {@link Number} to be converted to a {@link String}
+ *
+ * @see NaN
+ * @see Infinity
+ * @see Number.NaN
+ * @see Number.POSITIVE_INFINITY
+ * @see Number.NEGATIVE_INFINITY
+ */
+export type PossibleEdgeCaseNumericName = | "NaN" | "Infinity" | "-Infinity"
+
+/**
+ *
+ *
+ * @see PossibleTypescriptSymbolName
+ */
+export type PossibleJavascriptSymbolName = | "asyncIterator" | "iterator"
+                                           | "hasInstance" | "isConcatSpreadable"
+                                           | "match" | "matchAll"
+                                           | "replace" | "search" | "split"
+                                           | "species"
+                                           | "toPrimitive" | "toStringTag"
+                                           | "unscopables"
+
+/**
+ *
+ *
+ * @see PossibleJavascriptSymbolName
+ */
+export type PossibleTypescriptSymbolName = | "asyncIterator" | "iterator"
+                                           | "asyncDispose" | "dispose"
+                                           | "hasInstance" | "isConcatSpreadable"
+                                           | "match" | "matchAll"
+                                           | "replace" | "search" | "split"
+                                           | "metadata" | "species"
+                                           | "toPrimitive" | "toStringTag"
+                                           | "unscopables"

package/src/symbol.ts

@@ -0,0 +1,40 @@
+/*******************************************************************************
+ Copyright (c) 2023-2024. Jonathan Bédard ~ JóôòKiwi
+
+ This project is free to use.
+ All the right is reserved to the author of this project.
+ ******************************************************************************/
+
+import type {PossibleJavascriptSymbolName, PossibleTypescriptSymbolName} from "./string"
+
+/** A type-alias for an official Javascript {@link Symbol} as a primitive */
+export type JavascriptSymbol<T extends PossibleJavascriptSymbolName = PossibleJavascriptSymbolName, > = typeof Symbol[T]
+/** A type-alias for an official Typescript {@link Symbol} as a primitive */
+export type TypescriptSymbol<T extends PossibleTypescriptSymbolName = PossibleTypescriptSymbolName, > = typeof Symbol[T]
+
+/**
+ * A type-alias for a {@link Symbol}
+ * as a primitive or an object
+ *
+ * @see JavascriptSymbol
+ * @see TypescriptSymbol
+ * @see JavascriptSymbolOrObject
+ * @see TypescriptSymbolOrObject
+ */
+export type SymbolOrObject<T extends symbol = symbol, > = | T | Symbol
+/**
+ * A type-alias for an official Javascript {@link Symbol}
+ * as a primitive or an object
+ *
+ * @see JavascriptSymbol
+ * @see SymbolOrObject
+ */
+export type JavascriptSymbolOrObject<T extends JavascriptSymbol = JavascriptSymbol, > = | T | Symbol
+/**
+ * A type-alias for an official Typescript {@link Symbol}
+ * as a primitive or an object
+ *
+ * @see TypescriptSymbol
+ * @see SymbolOrObject
+ */
+export type TypescriptSymbolOrObject<T extends TypescriptSymbol = TypescriptSymbol, > = | T | Symbol