Skip to content

Commit 9aaabe0

Browse files
authored
Merge pull request #6 from Check-DC/feat/utils-setup
Feat/utils setup
2 parents 01bc779 + 9bdf1d9 commit 9aaabe0

5 files changed

+2203
-1805
lines changed

README.md

+19-10
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# TS-Utils
1+
# CHECK-DC/TS-UTILS
22

33
## Overview
44

5-
The ts-utils is a versatile TypeScript utility package that provides a collection of useful functions for various tasks, including array manipulation, date formatting, string & number operations, and object handling. This package offers essential tools to enhance your TypeScript projects with ease.
5+
The Check-DC/TS-utils is a versatile TypeScript utility package that provides a collection of useful functions for various tasks, including array manipulation, date formatting, string & number operations, and object handling. This package offers essential tools to enhance your TypeScript projects with ease.
66
Below is a brief overview of the main functions included in this package:
77

88
## Table of Contents
99

10-
- [TS-Utils](#ts-utils)
10+
- [CHECK-DC/TS-UTILS](#check-dc/ts-utils)
1111
- [Table of Contents](#table-of-contents)
1212
- [Utilities](#Functions)
1313
- [Installation](#Installation)
@@ -91,31 +91,40 @@ Below is a brief overview of the main functions included in this package:
9191

9292
## Installation
9393

94-
To install the ts-utils package, you can use the following command:
94+
To install the Check-DC/TS-Utils package, you can use the following command:
9595

9696
```bash
97-
npm install @ts-utils
97+
npm install @check-dc/ts-utils
9898
```
9999

100100
or
101101

102102
```bash
103-
yarn add @ts-utils
103+
yarn add @check-dc/ts-utils
104104
```
105105

106-
This command will fetch and install the ts-utils package from the package registry, making it available for use in your project.
106+
This command will fetch and install the Check-DC/TS-utils package from the package registry, making it available for use in your project.
107107

108108
### Usage
109109

110110
Once you have the file in your project, simply import the utility you need using the ES6 import statement.
111111

112112
```typescript
113113
// Import the specific method category you need
114-
import { randomStr, toUpperCase, toFullUrl } from "ts-utils/string.ts";
115-
import { formatNumber, parseNumber, addSeparators } from "ts-utils/number.ts";
114+
import { randomStr, toUpperCase, toFullUrl } from "check-dc/ts-utils/string.ts";
115+
import {
116+
formatNumber,
117+
parseNumber,
118+
addSeparators,
119+
} from "check-dc/ts-utils/number.ts";
116120

117121
// OR Import all utilities
118-
import { randomStr, toUpperCase, parseNumber, addSeparators } from "ts-utils";
122+
import {
123+
randomStr,
124+
toUpperCase,
125+
parseNumber,
126+
addSeparators,
127+
} from "check-dc/ts-utils";
119128
```
120129

121130
## Contributing

package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "ts-utils",
2+
"name": "@check-dc/ts-utils",
33
"version": "1.0.0",
44
"description": "A versatile TypeScript utility package that provides a collection of essential functions to enhance your TypeScript projects.",
55
"main": "./dist/index.js",

0 commit comments

Comments
 (0)