@kyco-utils/types 0.1.3 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,7 +1,25 @@
1
1
  # @kyco-utils/types
2
2
 
3
- A set of utilities for TS projects.
3
+ Shared, dependency-free TypeScript types.
4
+
5
+ ## Install
6
+
7
+ ```sh
8
+ pnpm add @kyco-utils/types
9
+ ```
10
+
11
+ Types only, no runtime code. ESM only.
12
+
13
+ ## Usage
14
+
15
+ ```ts
16
+ import type { NumberSeparators } from '@kyco-utils/types'
17
+
18
+ const separators: NumberSeparators = { thousandsSeparator: '.', decimalSeparator: ',' }
19
+ ```
20
+
21
+ See the [API reference](https://kyco.github.io/kyco-utils/api/@kyco-utils/types) for all exports.
4
22
 
5
23
  ## License
6
24
 
7
- [MIT](LICENSE)
25
+ [MIT](https://github.com/kyco/kyco-utils/blob/main/LICENSE)
package/dist/index.d.mts CHANGED
@@ -1,17 +1,20 @@
1
1
  /**
2
- * The thousands and decimal separators used to format numbers.
2
+ * Thousands and decimal separators used to format a number.
3
3
  *
4
4
  * @example
5
5
  * ```ts
6
6
  * import type { NumberSeparators } from '@kyco-utils/types'
7
7
  *
8
- * const separators: NumberSeparators = { thousandsSeparator: '.', decimalSeparator: ',' }
8
+ * const separators: NumberSeparators = {
9
+ * thousandsSeparator: '.',
10
+ * decimalSeparator: ',',
11
+ * }
9
12
  * ```
10
13
  */
11
14
  export type NumberSeparators = {
12
- /** Groups digits, e.g. `,` in `12,345`. */
15
+ /** Separates groups of digits, e.g. `,` in `12,345`. */
13
16
  thousandsSeparator: string;
14
- /** Separates the fraction, e.g. `.` in `12.5`. */
17
+ /** Separates the integer from the fraction, e.g. `.` in `12.5`. */
15
18
  decimalSeparator: string;
16
19
  };
17
20
  //# sourceMappingURL=index.d.mts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kyco-utils/types",
3
- "version": "0.1.3",
3
+ "version": "0.2.0",
4
4
  "description": "Shared, dependency-free TypeScript types for kyco-utils.",
5
5
  "type": "module",
6
6
  "sideEffects": false,
@@ -17,19 +17,10 @@
17
17
  "exports": {
18
18
  ".": {
19
19
  "@kyco-utils/source": "./src/index.ts",
20
- "import": {
21
- "types": "./dist/index.d.mts",
22
- "default": "./dist/index.mjs"
23
- },
24
- "require": {
25
- "types": "./dist/index.d.cts",
26
- "default": "./dist/index.cjs"
27
- }
20
+ "types": "./dist/index.d.mts",
21
+ "default": "./dist/index.mjs"
28
22
  }
29
23
  },
30
- "main": "./dist/index.cjs",
31
- "module": "./dist/index.mjs",
32
- "types": "./dist/index.d.cts",
33
24
  "publishConfig": {
34
25
  "access": "public",
35
26
  "provenance": true
@@ -37,7 +28,6 @@
37
28
  "scripts": {
38
29
  "build": "vp pack",
39
30
  "dev": "vp pack --watch",
40
- "typecheck": "tsc --noEmit",
41
- "lint": "biome check ."
31
+ "typecheck": "tsc --noEmit"
42
32
  }
43
33
  }
package/dist/index.cjs DELETED
File without changes
package/dist/index.d.cts DELETED
@@ -1,17 +0,0 @@
1
- /**
2
- * The thousands and decimal separators used to format numbers.
3
- *
4
- * @example
5
- * ```ts
6
- * import type { NumberSeparators } from '@kyco-utils/types'
7
- *
8
- * const separators: NumberSeparators = { thousandsSeparator: '.', decimalSeparator: ',' }
9
- * ```
10
- */
11
- export type NumberSeparators = {
12
- /** Groups digits, e.g. `,` in `12,345`. */
13
- thousandsSeparator: string;
14
- /** Separates the fraction, e.g. `.` in `12.5`. */
15
- decimalSeparator: string;
16
- };
17
- //# sourceMappingURL=index.d.cts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;;;;;;YAUY;;EAEV;;EAEA"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;;;;;;YAUY;;EAEV;;EAEA"}