https://github.com/andras-adam/comet

☄️ A powerful DX-first routing library for Cloudflare Workers.
https://github.com/andras-adam/comet

cloudflare cloudflare-workers comet dx router routing workers

Last synced: about 2 months ago
JSON representation

☄️ A powerful DX-first routing library for Cloudflare Workers.

• Host: GitHub
• URL: https://github.com/andras-adam/comet
• Owner: andras-adam
• License: mit
• Created: 2022-03-11T18:27:15.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-28T12:00:45.000Z (about 2 months ago)
• Last Synced: 2024-10-28T15:26:44.908Z (about 2 months ago)
• Topics: cloudflare, cloudflare-workers, comet, dx, router, routing, workers
• Language: TypeScript
• Homepage: https://npmjs.com/package/@neoaren/comet
• Size: 813 KB
• Stars: 10
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
![logo](.github/assets/comet_logo.png)



  ☄️ A powerful DX-first routing library for Cloudflare Workers.





  

  

  



-----

## Getting started

```ts

import { GET, server } from '@neoaren/comet'

const comet = server()

comet.route({ pathname: '/api/test/:id', method: GET }, async ({ event }) => {

  // Business logic

  return event.reply.ok({ id: event.params.id })

})

export default {

  fetch: comet.handler

}

```

## Documentation

A proper documentation for Comet is work in progress.

## Contribution guide

Use commit names with the following prefixes to indicate their purpose

| Emoji                    | Prefix                     | Description                                                |

|--------------------------|----------------------------|------------------------------------------------------------|

| :zap: :zap:              | `:zap: :zap:`              | for implementing breaking functionality (semver major)     |

| :zap:                    | `:zap:`                    | for implementing non-breaking functionality (semver minor) |

| :hammer:                 | `:hammer:`                 | for bug fixes and non-breaking improvements (semver patch) |

| :wrench:                 | `:wrench:`                 | for configurations                                         |

| :vertical_traffic_light: | `:vertical_traffic_light:` | for tests                                                  |

| :memo:                   | `:memo:`                   | for documentations                                         |

| :mag:                    | `:mag:`                    | for lint fixes                                             |

| :recycle:                | `:recycle:`                | for non-breaking refactoring                               |

| :paperclip:              | `:paperclip:`              | for dependencies                                           |

| :octocat:                | `:octocat:`                | for workflows                                              |

| :construction:           | `:construction:`           | for experimental or temporary changes                      |