Skip to content

Commit 98d09bf

Browse files
authored
Feat/len add debug class (#42)
* feat: add Debug class to project * BREAKING CHANGE: change the name of Numbers class to only Number
1 parent 5543ec3 commit 98d09bf

File tree

10 files changed

+1093
-93
lines changed

10 files changed

+1093
-93
lines changed

README.md

Lines changed: 45 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -421,24 +421,33 @@ await blacklist.remove('192.168.0.2', filePath) // void
421421

422422
---
423423

424-
### Numbers
424+
### Number
425425

426-
> Use Numbers to manipulate numbers the best way
426+
> Use Number to manipulate numbers the best way
427427
428428
```js
429-
import { Numbers } from '@secjs/utils'
429+
import { Number } from '@secjs/utils'
430430

431431
const arrayOfNumbers = [2, 4]
432432
const stringNumber = "Hello my name is João, I'm 20 year old!"
433433

434-
console.log(Numbers.getLower(arrayOfNumbers)) // 2
435-
console.log(Numbers.getHigher(arrayOfNumbers)) // 4
434+
// Get the lower/higher number from the array
435+
console.log(Number.getLower(arrayOfNumbers)) // 2
436+
console.log(Number.getHigher(arrayOfNumbers)) // 4
436437

437-
console.log(Numbers.extractNumber(stringNumber)) // '20'
438-
console.log(Numbers.extractNumbers(stringNumber)) // ['20']
438+
// Extract numbers from strings
439+
console.log(Number.extractNumber(stringNumber)) // '20'
440+
console.log(Number.extractNumbers(stringNumber)) // ['20']
439441

440-
console.log(Numbers.argsAverage(2, 4)) // 3
441-
console.log(Numbers.arrayAverage(arrayOfNumbers)) // 3
442+
// Return the average from infinite parameters or array of numbers
443+
console.log(Number.argsAverage(2, 4)) // 3
444+
console.log(Number.arrayAverage(arrayOfNumbers)) // 3
445+
446+
// Generate random integers values between interval
447+
console.log(Number.randomIntFromInterval(1, 1)) // 1
448+
console.log(Number.randomIntFromInterval(1, 2)) // 1
449+
console.log(Number.randomIntFromInterval(1, 2)) // 2
450+
console.log(Number.randomIntFromInterval(1, 10)) // 8
442451
```
443452

444453
---
@@ -608,6 +617,33 @@ console.log(Clean.cleanArraysInObject(object2)) // { number2: [{ number1: "numbe
608617

609618
---
610619

620+
### Debug
621+
622+
> Use Debug to generate debug logs in SecJS format
623+
624+
```js
625+
import { Debug } from '@secjs/utils'
626+
627+
const context = 'API'
628+
const namespace = 'api:main'
629+
630+
const debug = new Debug(context, namespace)
631+
632+
// You can still change the context/namespace of the instance in runtime
633+
debug
634+
.buildContext(context)
635+
.buildNamespace(namespace)
636+
.log('Hello World!') // api:main [SecJS Debugger] - PID: 85580 - 02/15/2022, 11:47:56 AM [API] Hello World! +0ms
637+
638+
// You can log objects too, it will be converted to string in the formatter
639+
debug
640+
.buildContext('Object')
641+
.buildNamespace('api:object')
642+
.log({ hello: 'world' }) // api:object [SecJS Debugger] - PID: 85770 - 02/15/2022, 11:53:48 AM [Object] {"hello":"world"} +0ms
643+
```
644+
645+
---
646+
611647
## Functions Usage
612648

613649
### getBranch

0 commit comments

Comments
 (0)