nuxt-cron - GitLite

KO | EN

gitlite — search

#javascript #python #react #ai #llm #go #android #deep-learning #nodejs #java #windows #awesome #vue #open-source

nuxt-cron

(★ 99)

A Nuxt module for cron jobs in your app.

파일 탐색기

최종 버전 다운로드 (.zip)

- - bug.yml
  - feature-request.yml
  - question.yml
- - pull_request_template.md
- - ci.yml
  - docs.yml
  - welcome.yml
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- renovate.json
- commit-msg
- pre-commit
- - config.ts
- - cron-handler.md
  - presets.md
- - code-of-conduct.md
  - contributing.md
- - async.md
  - base.md
  - custom-time.md
  - with-params.md
- - configuration.md
  - getting-started.md
- - changelog.md
  - license.md
- - cover.jpg
  - favicon.ico
  - logotype.svg
- .gitignore
- CNAME
- index.md
- playground.md
- - tsconfig.json
- app.vue
- nuxt.config.ts
- package.json
- tsconfig.json
- - server.ts
  - types.ts
- module.ts
.editorconfig
.gitignore
.npmrc
CHANGELOG.md
eslint.config.js
LICENSE
package.json
pnpm-lock.yaml
README.md
tsconfig.json

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/hywax/nuxt-cron

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd nuxt-cron

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

pnpm add nuxt-cron -D

이 명령어를 터미널에 그대로 입력해 실행하세요.

yarn add nuxt-cron -D

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm install nuxt-cron -D

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![nuxt-cron](https://raw.githubusercontent.com/hywax/nuxt-cron/main/docs/public/cover.jpg)](https://nuxt-cron.hywax.space)

# Nuxt Cron

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]

A Nuxt module for cron jobs in your app.

- [📖 Documentation](https://nuxt-cron.hywax.space)
- [🏀 Playground](https://nuxt-cron.hywax.space/playground)
- [✨ Releases](https://github.com/hywax/nuxt-cron/releases)

## Features

- 👌&nbsp; 19 time presets
- 🕔️&nbsp; Time zone support
- 🪄️&nbsp; TypeScript support
- ✨&nbsp; Auto imports enabled
- ⚡&nbsp; Zero configuration to start
- 🤝&nbsp; Nuxt 3/4 support
- 📦&nbsp; Extendable by [Nuxt modules](https://nuxt.com/modules)

## Installation

```bash
# Using pnpm
pnpm add nuxt-cron -D

# Using yarn
yarn add nuxt-cron -D

# Using npm
npm install nuxt-cron -D
```

## Usage

### Setup

Add `nuxt-cron` to the `modules` section of `nuxt.config.ts`

```js
export default defineNuxtConfig({
  modules: ['nuxt-cron']
})
```

### Configuration

You can configure the module by adding a `nuxt-cron` section to your nuxt.config file.

```js
export default defineNuxtConfig({
  cron: {
    runOnInit: true,
    timeZone: 'Africa/Abidjan',
    jobsDir: 'cron'
  }
})
```

by default, `nuxt-cron` will auto-import your cron from the models directory from server directory. You can change this behavior by setting the `jobsDir` option.

## API

### defineCronHandler

This function creates a new cron job. Example usage:

```ts
// server/cron/job.ts
import { defineCronHandler } from '#nuxt/cron'

export default defineCronHandler('everySecond', () => {
  console.log('I run every seconds')
})
```

or use with params:

```ts
// server/cron/job.ts
import { defineCronHandler } from '#nuxt/cron'

export default defineCronHandler('everySecond', () => {
  console.log('I run every seconds')
}, { runOnInit: true })
```

More examples can be found [here](https://nuxt-cron.hywax.space/examples/base.html).

## Credits

A huge thank you to everyone who is helping to improve `nuxt-cron`. Thanks to you, the project can evolve!

### Contributors

To become a contributor, please follow our [contributing guide](https://nuxt-cron.hywax.space/community/contributing.html).

<img src="https://contrib.rocks/image?repo=hywax/nuxt-cron" alt="nuxt-cron" />

## License

This app is open-sourced software licensed under the [MIT license](https://github.com/hywax/nuxt-cron/blob/main/LICENSE).

[npm-version-src]: https://img.shields.io/npm/v/nuxt-cron/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/nuxt-cron
[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-cron.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/nuxt-cron
[license-src]: https://img.shields.io/npm/l/nuxt-cron.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/nuxt-cron