https://github.com/ihcccjs/hooks

A base react-hooks library.
https://github.com/ihcccjs/hooks

Last synced: 8 months ago
JSON representation

A base react-hooks library.

• Host: GitHub
• URL: https://github.com/ihcccjs/hooks
• Owner: IhcccJS
• License: mit
• Created: 2023-12-04T09:58:35.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-25T16:16:48.000Z (over 2 years ago)
• Last Synced: 2025-01-04T13:55:29.397Z (over 1 year ago)
• Language: TypeScript
• Size: 29.3 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

# @ihccc/hooks

A base react-hooks library.

[![NPM version](https://img.shields.io/npm/v/@ihccc/hooks.svg?style=flat)](https://npmjs.org/package/@ihccc/hooks)

[![NPM downloads](http://img.shields.io/npm/dm/@ihccc/hooks.svg?style=flat)](https://npmjs.org/package/@ihccc/hooks)

[![dumi](https://img.shields.io/badge/docs%20by-dumi-blue)](https://github.com/umijs/dumi)

## Documentation

[Documentation](https://ihccc/hooks)

## Installation

Install `@ihccc/hooks` with npm

```bash

  pnpm i @ihccc/hooks

```

## Usage/Examples

```javascript

import { useApi } from '@ihccc/hooks'

function UserList() {

  const users = useApi(getAllUser, {

    auto: true

  });

  // ...

}

```

## Run Locally

Clone the project

```bash

  git clone https://@ihccc/hooks

```

Go to the project directory

```bash

  cd hooks

```

Install dependencies

```bash

  pnpm install

```

Start the server

```bash

  pnpm run dev

```

## Running Tests

To run tests, run the following command

```bash

  pnpm run test

```

## Deployment

To deploy this project run

```bash

  pnpm run deploy

```

## License

[MIT](https://choosealicense.com/licenses/mit/)