Skip to content

Commit 1df3414

Browse files
committed
add README.md
1 parent 2ee4383 commit 1df3414

1 file changed

Lines changed: 71 additions & 0 deletions

File tree

README.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# @full-pack/string-builder
2+
3+
[![npm](https://img.shields.io/npm/v/@full-pack/string-builder.svg)](https://www.npmjs.com/package/@full-pack/string-builder)
4+
5+
[![jest](https://jestjs.io/img/jest-badge.svg)](https://github.com/jestjs/jest) [![Code Style: Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
6+
7+
A lightweight and versatile String Utility Package for Node.js & Browser.
8+
9+
<img src="https://user-images.githubusercontent.com/6517308/121813242-859a9700-cc6b-11eb-99c0-49e5bb63005b.jpg">
10+
11+
12+
## Installation
13+
```sh
14+
npm install @full-pack/string-builder
15+
```
16+
17+
### require
18+
19+
```js
20+
const { ... } = require('@full-pack/string-builder');
21+
```
22+
23+
### import
24+
25+
```js
26+
import { ... } from '@full-pack/string-builder';
27+
```
28+
29+
## APIs
30+
### Class
31+
* string-builder
32+
### Data Members
33+
* capacity: number
34+
* length: number
35+
### Methods
36+
* insert
37+
* append
38+
* prepend
39+
* appendNewLine
40+
* prependNewLine
41+
* appendSpace
42+
* prependSpace
43+
* appendArray
44+
* prependArray
45+
* appendJSON
46+
* prependJSON
47+
* appendCodePoint
48+
* prependCodePoint
49+
* replaceSubstring
50+
* setString
51+
* getString
52+
* indexOf
53+
* lastIndexOf
54+
* setChar
55+
* substring
56+
* trim
57+
* clear
58+
* reset
59+
* clone
60+
* isFull
61+
* isEmpty
62+
63+
Full documentation [here](https://full-pack.github.io/string-builder)
64+
65+
## Build
66+
```
67+
npm run build
68+
```
69+
70+
## License
71+
The MIT License. Full License is [here](LICENSE)

0 commit comments

Comments
 (0)