Skip to content

Commit

Permalink
feat(docs): add desc about all helpers
Browse files Browse the repository at this point in the history
  • Loading branch information
jlenon7 committed Aug 18, 2023
1 parent 3382280 commit c12a5a9
Showing 1 changed file with 72 additions and 0 deletions.
72 changes: 72 additions & 0 deletions docs/the-basics/helpers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ them in your own applications if you find them convenient.
from different data structures.
- [`Color`](/docs/the-basics/helpers#color) - The UI Kit of Athenna
command line applications.
- [`Exception`](/docs/the-basics/helpers#exception) - Create errors with
more details to handle them easily.
- [`Exec`](/docs/the-basics/helpers#exec) - Simple helpers that executes
some operation, like executing a command in a child process.
- [`FakeApi`](/docs/the-basics/helpers#fakeapi) - Create a fake REST API
Expand All @@ -33,6 +35,28 @@ using `json` files to map the routes and their returns (similiar to [WireMock](h
delete and get information about files.
- [`Folder`](/docs/the-basics/helpers#folder) - Create, copy, move,
delete and get information about folders.
- [`HttpClient`](/docs/the-basics/helpers#httpclient) - Make HTTP requests for
other servers with a human-friendly and powerful API.
- [`Is`](/docs/the-basics/helpers#is) - Validate if your data **is**
equals to some type or pattern.
- [`Json`](/docs/the-basics/helpers#json) - Simple helpers to manipulate JSON.
- [`Module`](/docs/the-basics/helpers#module) - Simple helpers to manipulate
Node.js modules.
- [`Number`](/docs/the-basics/helpers#number) - Simple helpers to manipulate
numbers.
- [`Options`](/docs/the-basics/helpers#options) - Simple helpers to develop
API's (functions and methods) with good options and configurations for
developers.
- [`Parser`](/docs/the-basics/helpers#parser) - Parse data from X to Y and Y to X.
- [`Path`](/docs/the-basics/helpers#path) - Get the full path to some file or
folder starting from your application
[PWD](https://www.computerhope.com/jargon/p/pwd.htm).
- [`Route`](/docs/the-basics/helpers#route) - Simple helpers to manipulate
route params, query params and more.
- [`String`](/docs/the-basics/helpers#string) - Simple helpers to manipulate
strings.
- [`Uuid`](/docs/the-basics/helpers#uuid) - Create customized UUID v4 and
validate if they are valid.

### `Clean`

Expand All @@ -42,6 +66,10 @@ Coming soon

Coming soon

### `Exception`

Coming soon

### `Exec`

Coming soon
Expand Down Expand Up @@ -542,3 +570,47 @@ if (await Folder.size('app') === 100) {
// do something
}
```

### `HttpClient`

Coming soon

### `Is`

Coming soon

### `Json`

Coming soon

### `Module`

Coming soon

### `Number`

Coming soon

### `Options`

Coming soon

### `Parser`

Coming soon

### `Path`

Coming soon

### `Route`

Coming soon

### `String`

Coming soon

### `Uuid`

Coming soon

0 comments on commit c12a5a9

Please sign in to comment.