@kyco-utils/types 0.1.2 → 0.2.0

package/README.md

@@ -1,7 +1,25 @@
 # @kyco-utils/types
 
-A set of utilities for TS projects.
+Shared, dependency-free TypeScript types.
+
+## Install
+
+```sh
+pnpm add @kyco-utils/types
+```
+
+Types only, no runtime code. ESM only.
+
+## Usage
+
+```ts
+import type { NumberSeparators } from '@kyco-utils/types'
+
+const separators: NumberSeparators = { thousandsSeparator: '.', decimalSeparator: ',' }
+```
+
+See the [API reference](https://kyco.github.io/kyco-utils/api/@kyco-utils/types) for all exports.
 
 ## License
 
-[MIT](LICENSE)
+[MIT](https://github.com/kyco/kyco-utils/blob/main/LICENSE)

package/dist/index.d.mts

@@ -1,8 +1,20 @@
 /**
- * The thousands and decimal separators used to format numbers.
+ * Thousands and decimal separators used to format a number.
+ *
+ * @example
+ * ```ts
+ * import type { NumberSeparators } from '@kyco-utils/types'
+ *
+ * const separators: NumberSeparators = {
+ *   thousandsSeparator: '.',
+ *   decimalSeparator: ',',
+ * }
+ * ```
  */
 export type NumberSeparators = {
+  /** Separates groups of digits, e.g. `,` in `12,345`. */
   thousandsSeparator: string;
+  /** Separates the integer from the fraction, e.g. `.` in `12.5`. */
   decimalSeparator: string;
 };
 //# sourceMappingURL=index.d.mts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kyco-utils/types",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Shared, dependency-free TypeScript types for kyco-utils.",
   "type": "module",
   "sideEffects": false,
@@ -17,19 +17,10 @@
   "exports": {
     ".": {
       "@kyco-utils/source": "./src/index.ts",
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
     }
   },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.cts",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -37,7 +28,6 @@
   "scripts": {
     "build": "vp pack",
     "dev": "vp pack --watch",
-    "typecheck": "tsc --noEmit",
-    "lint": "biome check ."
+    "typecheck": "tsc --noEmit"
   }
 }

package/dist/index.d.cts

@@ -1,8 +0,0 @@
-/**
- * The thousands and decimal separators used to format numbers.
- */
-export type NumberSeparators = {
-  thousandsSeparator: string;
-  decimalSeparator: string;
-};
-//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"mappings":";;;YAGY;EACV;EACA"}

package/dist/index.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;YAGY;EACV;EACA"}