An open API service indexing awesome lists of open source software.

https://github.com/geisonjr/alpha


https://github.com/geisonjr/alpha

Last synced: 12 months ago
JSON representation

Awesome Lists containing this project

README

          






HansoMWarE Alpha Library


Easy to use, fast and lightweight library for Node.js.


Discord server


MIT Licence


NPM version


NPM downloads

> :construction: This project is under development and is not yet ready for use.

## :link: Table of Contents

- [:sparkles: Features](#sparkles-features)
- [:rocket: Tecnologies](#rocket-tecnologies)
- [:package: Install](#package-install)
- [:hammer: Usage](#hammer-usage)
- [:handshake: How to Contribute](#handshake-how-to-contribute)
- [:memo: License](#memo-license)

## :sparkles: Features

- :white_check_mark: Sleep syncronous
- :white_check_mark: JSON decycle
- :white_check_mark: Types check
- :white_check_mark: Filesystem utils
- :x: Fetch syncronous
- :x: Panda procrastinating

## :rocket: Tecnologies

The following tools were used in the construction of the project:

- [Jest](https://jestjs.io/)
- [Node.js](https://nodejs.org/en/)
- [SWC](https://swc.rs/)
- [TypeScript](https://www.typescriptlang.org/)

## :package: Install

> :warning: Node.js 14.6.0 or newer is required.

Use the package manager [npm](https://docs.npmjs.com/),
[yarn](https://classic.yarnpkg.com/lang/en/docs/) or
[pnpm](https://pnpm.io/pt/motivation).

```bash
npm install @hansomware/alpha
```

```bash
yarn add @hansomware/alpha
```

```bash
pnpm add @hansomware/alpha
```

## :hammer: Usage

```typescript
import { isArray } from "@hansomware/alpha/types";

if (isArray([1, '2'])) {
console.log('It is an array');
}
```

## :handshake: How to Contribute

Pull requests are welcome. For major changes, please open an issue first to
discuss what you would like to change.

Please make sure to update tests as appropriate.

## :memo: License

This project is under the
[MIT License](https://github.com/hansomware-inc/alpha/blob/master/LICENSE)