https://github.com/nurodev/untypeable

❗️ A lot of RESTful API's are not typed, let's type them
https://github.com/nurodev/untypeable

api api-wrapper api-wrappers monorepo monorepository npm npm-package package rest rest-api restful-api typescript untypeable

Last synced: 2 months ago
JSON representation

❗️ A lot of RESTful API's are not typed, let's type them

• Host: GitHub
• URL: https://github.com/nurodev/untypeable
• Owner: NuroDev
• License: mit
• Created: 2023-03-14T15:18:54.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-28T18:29:52.000Z (8 months ago)
• Last Synced: 2024-05-29T04:45:13.367Z (7 months ago)
• Topics: api, api-wrapper, api-wrappers, monorepo, monorepository, npm, npm-package, package, rest, rest-api, restful-api, typescript, untypeable
• Language: TypeScript
• Homepage: https://npmjs.com/org/untypeable
• Size: 683 KB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  


    


    


    ❗️

    


    @untypeable

    


    


    


    


  

  

    


    A lot of RESTful API's are not typed, let's type them

    


    


  

[![Tests status](https://img.shields.io/github/actions/workflow/status/nurodev/untypeable/test.yml?branch=main&label=%20&logo=github&logoColor=white&style=for-the-badge)](https://github.com/nurodev/untypeable/actions/workflows/test.yml)


  

  


  




## ❓ What is `@untypeable`?

`@untypeable` is a collection of packages built around the [`untypeable`](https://github.com/total-typescript/untypeable) package, which allows you get type-safe access to any API.

In this case we are doing the heavy lifting by creating type definitions for all the most popular API's out there. This way you are able to use your favourite RESTful API's with complete type safety.

## 📦 Packages

The following are all currently supported `@untypeable` packages. Click on one below to view it & read more on how to install & use it.

- [🗞️ Hacker News](packages/hackernews)

- [🗿 JSONPlaceholder](packages/jsonplaceholder)

- [🤏 lil APIs](packages/lil.apis)

- [📱 LogSnag](packages/logsnag)

- [🗿 JSONPlaceholder](packages/jsonplaceholder)

- [🚀 SpaceX](packages/spacex)

- [🪐 SWAPI](packages/swapi)

- [🔢 UUID.rocks](packages/uuid.rocks)

## 🏃‍♂️ Examples

If you want to see an example of any of the packages in action & being used, have a look in the `examples/` directory to view a simple script that uses [`untypeable`](https://github.com/total-typescript/untypeable) & whatever package we've built to see what it looks like.

If however you want to actually run any of those examples to prove they work, simply run the following command & select the example you want to run:

```bash

# npm

npm run example

# yarn

yarn run example

# pnpm

pnpm run example

```