@nyaomaru/divider 1.8.6 โ†’ 1.8.8

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.
Files changed (4) hide show
  1. package/README.md +5 -0
  2. package/dist/index.d.cts +0 -1
  3. package/dist/index.d.ts +0 -1
  4. package/package.json +4 -2
package/README.md CHANGED
@@ -39,6 +39,11 @@ bun add @nyaomaru/divider
39
39
  yarn add @nyaomaru/divider
40
40
  ```
41
41
 
42
+ ## ๐Ÿ“– Documentation
43
+
44
+ - ๐Ÿ“ Guide: [https://divider-docs.vercel.app](https://divider-docs.vercel.app)
45
+ - ๐Ÿงช API Reference: [https://nyaomaru.github.io/divider/](https://nyaomaru.github.io/divider/)
46
+
42
47
  ## ๐Ÿ“– Usage
43
48
 
44
49
  ๐Ÿ‘‰ [Check out the full documentation here!](https://divider-docs.vercel.app/)
package/dist/index.d.cts CHANGED
@@ -52,7 +52,6 @@ type DividerArgs = DividerSeparators | [...DividerSeparators, DividerOptions];
52
52
  * @param input - String or array of strings to divide
53
53
  * @param args - Array of separators (numbers/strings) and optional options object
54
54
  * @returns Divided string segments based on input type and options
55
- * @throws {DividerValidationError} If input or separators are invalid
56
55
  */
57
56
  declare function divider<T extends DividerInput>(input: T, ...args: DividerArgs): DividerResult<T>;
58
57
 
package/dist/index.d.ts CHANGED
@@ -52,7 +52,6 @@ type DividerArgs = DividerSeparators | [...DividerSeparators, DividerOptions];
52
52
  * @param input - String or array of strings to divide
53
53
  * @param args - Array of separators (numbers/strings) and optional options object
54
54
  * @returns Divided string segments based on input type and options
55
- * @throws {DividerValidationError} If input or separators are invalid
56
55
  */
57
56
  declare function divider<T extends DividerInput>(input: T, ...args: DividerArgs): DividerResult<T>;
58
57
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@nyaomaru/divider",
3
3
  "type": "module",
4
- "version": "1.8.6",
4
+ "version": "1.8.8",
5
5
  "description": "To divide string or string[] with a given separator",
6
6
  "main": "./dist/index.cjs",
7
7
  "module": "./dist/index.js",
@@ -47,6 +47,7 @@
47
47
  "ts-node": "^10.9.2",
48
48
  "tsup": "^8.4.0",
49
49
  "tsx": "^4.19.4",
50
+ "typedoc": "^0.28.5",
50
51
  "typescript": "^5.8.3"
51
52
  },
52
53
  "engines": {
@@ -59,6 +60,7 @@
59
60
  "scripts": {
60
61
  "test": "jest",
61
62
  "lint": "eslint .",
62
- "build": "tsup"
63
+ "build": "tsup",
64
+ "typedoc": "typedoc"
63
65
  }
64
66
  }