@joookiwi/type 1.0.0

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@joookiwi/type",
+  "version": "1.0.0",
+  "description": "A typescript project to encapsulate a bunch of common type-aliases",
+
+  "scripts": {
+    "clear-dist-folder": "del-cli dist/",
+
+    "build": "tsc",
+
+    "test-pack":    "npm pack --dry-run",
+    "test-publish": "npm publish --@access=public --dry-run",
+
+    "pack": "npm pack",
+
+    "local-publish":  "npm link",
+    "publish-to-npm": "npm publish --access=public"
+  },
+
+  "directories": {
+    "lib": "./src",
+    "test": "./test"
+  },
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": { "types":   "./dist/index.d.ts" },
+    "./*": { "types": "./dist/*.d.ts" }
+  },
+
+  "files": [
+    "dist",
+    "src",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/joooKiwi/types.git"
+  },
+  "bugs": {
+    "url": "https://github.com/joooKiwi/types/issues"
+  },
+
+  "keywords": [
+    "type-alias",
+    "types",
+    "nullable types",
+    "boolean types",
+    "bigint types",
+    "character types",
+    "empty types",
+    "number types",
+    "numeric types",
+    "string types"
+  ],
+  "funding": [
+    { "type": "github",          "url": "https://github.com/sponsors/joooKiwi" },
+    { "type": "buy-me-a-coffee", "url": "https://www.buymeacoffee.com/joookiwi" }
+  ],
+  "author": "JóôòKiwi",
+  "license": "MIT",
+  "devDependencies": {
+    "del-cli": "^5.1.0",
+    "typescript": "^5.4.2"
+  }
+}

package/src/boolean (false).ts

@@ -0,0 +1,30 @@
+/*******************************************************************************
+ 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>false</b> as a primitive */
+export type False<T extends false = false, > = T
+
+/**
+ * A type-alias for the {@link Boolean} <b>false</b>
+ * in a {@link String} template
+ *
+ * @see False
+ * @see Template
+ * @see BooleanTemplate
+ */
+export type FalseTemplate<T extends false = false, > = `${T}`
+
+/**
+ * A type-alias for the {@link Boolean} <b>false</b>
+ * as a primitive or in a {@link String} template
+ *
+ * @see False
+ * @see Template
+ * @see FalseOrTemplateOrObject
+ * @see TemplateOrBoolean
+ */
+export type TemplateOrFalse<T extends false = false, > = | T | `${T}`

package/src/boolean (true).ts

@@ -0,0 +1,31 @@
+/*******************************************************************************
+ 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 primitive */
+export type True<T extends true = true, > = T
+
+/**
+ * A type-alias for the {@link Boolean} <b>true</b>
+ * in a {@link String} template
+ *
+ * @see True
+ * @see Template
+ * @see BooleanTemplate
+ */
+export type TrueTemplate<T extends true = true, > = `${T}`
+
+/**
+ * A type-alias for the {@link Boolean} <b>true</b>
+ * in a {@link String} template
+ *
+ * @see True
+ * @see Template
+ * @see TrueTemplate
+ * @see TrueOrTemplateOrObject
+ * @see TemplateOrBoolean
+ */
+export type TemplateOrTrue<T extends true = true, > = | T | `${T}`

package/src/boolean.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 Boolean}
+ * in a {@link String} template
+ *
+ * @see Template
+ * @see TrueTemplate
+ * @see FalseTemplate
+ */
+export type BooleanTemplate<T extends boolean = boolean, > = `${T}`
+
+/**
+ * A type-alias for a {@link Boolean}
+ * as a primitive or in a {@link String} template
+ *
+ * @see Template
+ * @see TemplateOrTrue
+ * @see TemplateOrFalse
+ * @see TemplateOrBooleanOrObject
+ */
+export type TemplateOrBoolean<T extends boolean = boolean, > = | T | `${T}`
+
+/**
+ * A type-alias for a {@link Boolean}
+ * as a primitive or an object
+ *
+ * @see TemplateOrBooleanOrObject
+ */
+export type BooleanOrObject<T extends boolean = boolean, > = | T | Boolean
+
+/**
+ * A type-alias for a {@link Boolean}
+ * as a primitive, an object or in a {@link String} template
+ *
+ * @see Template
+ * @see BooleanOrObject
+ * @see TemplateOrBoolean
+ */
+export type TemplateOrBooleanOrObject<T extends boolean = boolean, > = | T | `${T}` | Boolean

package/src/empty.ts

@@ -0,0 +1,57 @@
+/*******************************************************************************
+ 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 an empty {@link String} */
+export type EmptyString = ""
+
+/**
+ * A type-alias for an empty {@link ReadonlyArray Array}
+ *
+ * @see EmptyMutableArray
+ */
+export type EmptyArray = readonly []
+/**
+ * A type-alias for an empty {@link Array MutableArray}
+ *
+ * @see EmptyArray
+ */
+export type EmptyMutableArray = []
+
+/** A type-alias for an empty {@link ReadonlySet Set} */
+export type EmptySet = ReadonlySet<never>
+
+/** A type-alias for an empty {@link WeakSet} */
+export type EmptyWeakSet = Readonly<WeakSet<WeakKey>>
+
+/**
+ * A type-alias for an empty {@link ReadonlyMap Map}
+ *
+ * @see EmptyMutableMap
+ */
+export type EmptyMap = ReadonlyMap<any, never>
+/**
+ * A type-alias for an empty {@link Map MutableMap}
+ *
+ * @see EmptyMap
+ */
+export type EmptyMutableMap = Map<any, never>
+
+/** A type-alias for an empty {@link WeakMap} */
+export type EmptyWeakMap = Readonly<WeakMap<WeakKey, never>>
+
+/**
+ * A type-alias for an empty {@link Object}
+ *
+ * @see EmptyMutableObject
+ */
+export type EmptyObject = Readonly<{}>
+/**
+ * A type-alias for an empty {@link Object} (that can be modified)
+ *
+ * @see EmptyObject
+ */
+export type EmptyMutableObject = {}

package/src/index.ts

@@ -0,0 +1,23 @@
+/*******************************************************************************
+ 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.
+ ******************************************************************************/
+
+export type * from "./boolean"
+export type * from "./boolean (false)"
+export type * from "./boolean (true)"
+export type * from "./empty"
+export type * from "./mixed"
+export type * from "./nullable"
+export type * from "./numeric"
+export type * from "./numeric (0)"
+export type * from "./numeric (1)"
+export type * from "./numeric (2)"
+export type * from "./numeric (-1)"
+export type * from "./numeric (bigint)"
+export type * from "./numeric (number)"
+export type * from "./string"
+export type * from "./string (individual)"
+export type * from "./symbol"