docs: ChainableStringBuilder API

Author: ram-amoncar

README.md

@@ -15,58 +15,99 @@ A lightweight and versatile String Utility Package for Node.js & Browser.
 npm install @full-pack/string-builder
 ```
 
-### require
+### CommonJS(require)
 
 ```js
 const { ... } = require('@full-pack/string-builder');
 ```
 
-### import
+### ESM(import)
 
 ```js
 import { ... } from '@full-pack/string-builder';
 ```
 
 ## APIs
-### Class
-* string-builder
+
+### Class: StringBuilder
+
+### Data Members
+
+- capacity: number
+- length: number
+
+### Methods
+
+```ts
+insert(index: number, value: number | string | boolean, repeatCount?: number): boolean;
+append(value: number | string | boolean, repeatCount?: number): boolean;
+prepend(value: number | string | boolean, repeatCount?: number): boolean;
+appendNewLine(num?: number): boolean;
+prependNewLine(num?: number): boolean;
+appendSpace(num?: number): boolean;
+prependSpace(num?: number): boolean;
+appendArray(arr: Array<number | string | boolean>, separator?: string): boolean;
+prependArray(arr: Array<number | string | boolean>, separator?: string): boolean;
+appendJSON(json: Record<string | number | symbol, unknown> | Array<Record<string | number | symbol, unknown>>, space?: string | number): boolean;
+prependJSON(json: Record<string | number | symbol, unknown> | Array<Record<string | number | symbol, unknown>>, space?: string | number): boolean;
+appendCodePoint(...codePoints: number[]): boolean;
+prependCodePoint(...codePoints: number[]): boolean;
+replaceSubstring(str: string | Replacer, start?: number, end?: number): boolean;
+setString(value: string): boolean;
+getString(): string;
+indexOf(searchString: string, position?: number): number;
+lastIndexOf(searchString: string, position?: number): number;
+setChar(index: number, char: string): string;
+substring(start: number, end?: number): string;
+trim(): void;
+clear(): void;
+reset(): void;
+clone(): StringBuilder;
+isFull(): boolean;
+isEmpty(): boolean;
+```
+
+### Class: ChainableStringBuilder
+
 ### Data Members
-* capacity: number
-* length: number
+
+- capacity: number
+- length: number
+
 ### Methods
-* insert
-* append
-* prepend
-* appendNewLine
-* prependNewLine
-* appendSpace
-* prependSpace
-* appendArray
-* prependArray
-* appendJSON
-* prependJSON
-* appendCodePoint
-* prependCodePoint
-* replaceSubstring
-* setString
-* getString
-* indexOf
-* lastIndexOf
-* setChar
-* substring
-* trim
-* clear
-* reset
-* clone
-* isFull
-* isEmpty
+
+```ts    
+insert(index: number, value: number | string | boolean, repeatCount?: number): ChainableStringBuilder;
+append(value: number | string | boolean, repeatCount?: number): ChainableStringBuilder;
+prepend(value: number | string | boolean, repeatCount?: number): ChainableStringBuilder;
+appendNewLine(num?: number): ChainableStringBuilder;
+prependNewLine(num?: number): ChainableStringBuilder;
+appendSpace(num?: number): ChainableStringBuilder;
+prependSpace(num?: number): ChainableStringBuilder;
+appendArray(arr: Array<number | string | boolean>, separator?: string): ChainableStringBuilder;
+prependArray(arr: Array<number | string | boolean>, separator?: string): ChainableStringBuilder;
+appendJSON(json: Record<string | number | symbol, unknown> | Array<Record<string | number | symbol, unknown>>, space?: string | number): ChainableStringBuilder;
+prependJSON(json: Record<string | number | symbol, unknown> | Array<Record<string | number | symbol, unknown>>, space?: string | number): ChainableStringBuilder;
+appendCodePoint(...codePoints: number[]): ChainableStringBuilder;
+prependCodePoint(...codePoints: number[]): ChainableStringBuilder;
+replaceSubstring(str: string | Replacer, start?: number, end?: number): ChainableStringBuilder;
+setString(value: string): ChainableStringBuilder;
+trim(): ChainableStringBuilder;
+clear(): ChainableStringBuilder;
+reset(): ChainableStringBuilder;
+clone(): ChainableStringBuilder;
+build(): StringBuilder;
+getString(): string;
+```
 
 Full documentation [here](https://full-pack.github.io/string-builder)
 
 ## Build
+
 ```
 npm run build
 ```
 
 ## License
+
 The MIT License. Full License is [here](LICENSE)