https://github.com/nbbaier/valtown-api-types

Provides the Val Town OpenAPI spec as a ts export
https://github.com/nbbaier/valtown-api-types

Last synced: about 2 months ago
JSON representation

Provides the Val Town OpenAPI spec as a ts export

• Host: GitHub
• URL: https://github.com/nbbaier/valtown-api-types
• Owner: nbbaier
• Created: 2023-07-28T20:54:56.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-23T05:48:20.000Z (over 1 year ago)
• Last Synced: 2025-03-16T17:18:38.252Z (3 months ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/valtown-api-types
• Size: 38.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# valtown-api-types

This package provides the [Val Town OpenAPI spec](https://www.val.town/docs/openapi.yaml) as a Typescript file. 

# Usage 

This package is intended for use with a [`fets`](https://github.com/ardatan/feTS) API client.

```ts

import { NormalizeOAS, createClient } from "fets";

import openapi from "valtown-api-types";

const token = "";

const client = createClient>({

  endpoint: "https://api.val.town",

});

const resp = await client["/v1/alias/{username}/{val_name}"].get({

  params: { username: "nbbaier", val_name: "hello" },

  headers: { Authorization: `Bearer ${token}` },

});

const val = await resp.json();

console.log(val);

```