qmk

Index

Classes

Type aliases

Variables

Functions

Type aliases

API_VERSION

API_VERSION: "v1"

Key

Key: object

Type declaration

label: string
x: number
y: number

Keyboard

Keyboard: object

Type declaration

bootloader: string
description: string
device_ver: string
height: number
identifier: string
keyboard_folder: string
keyboard_name: string
keymaps: string[]
layouts: Layouts
maintainer: string
Optional manufacturer?: undefined | string
platform: string
processor: string
processor_type: string
Optional product_id?: string | number
readme: boolean
url: string
Optional vendor_id?: string | number
width: number

KeyboardMeta

KeyboardMeta: object

Type declaration

description: string | boolean
keyboard: string
manufacturer: string
product_id: string
vendor_id: string

Keyboards

Keyboards: object

Type declaration

[name: string]: Keyboard

KeyboardsMeta

KeyboardsMeta: object

Type declaration

[keyboard: string]: KeyboardMeta

KeyboardsResponse

KeyboardsResponse: object

Type declaration

Optional git_hash?: undefined | string
keyboards: Keyboards
last_updated: string

Layout

Layout: object

Type declaration

key_count: number
layout: Key[]

Layouts

Layouts: object

Type declaration

[name: string]: Layout

PostData

PostData: object | string

Products

Products: object

Type declaration

[productID: string]: KeyboardsMeta

QueryParam

QueryParam: QueryPrimitive | QueryPrimitive[]

QueryParams

QueryParams: object

Type declaration

[key: string]: QueryParam

QueryPrimitive

QueryPrimitive: string | number | boolean

RequestMethod

Vendors

Vendors: object

Type declaration

[vendorID: string]: Products

Variables

Const API_ROOT

API_ROOT: "https://api.qmk.fm/" = "https://api.qmk.fm/"

Headers

Headers: object

Type declaration

constructor: function
- new __type(init?: HeadersInit): Headers
- - Defined in F:/Users/matt/Documents/GitHub/qmk/node_modules/@bitjson/typedoc/node_modules/typescript/lib/lib.dom.d.ts:8873
  Parameters
  - Optional init: HeadersInit
  Returns Headers
prototype: Headers

Request

Request: object

Type declaration

constructor: function
- new __type(input: RequestInfo, init?: RequestInit): Request
- - Defined in F:/Users/matt/Documents/GitHub/qmk/node_modules/@bitjson/typedoc/node_modules/typescript/lib/lib.dom.d.ts:12446
  Parameters
  - input: RequestInfo
  - Optional init: RequestInit
  Returns Request
prototype: Request

fetch

fetch: fetch

Functions

Const fetchData

fetchData<T>(r: RequestInfo): Promise<T>

- Defined in lib/api/fetch.ts:43
Simple wrapper around fetch. If the response code is OK .json() is called on the response. Otherwise a RequestError will be raised https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch

Type parameters
- T
Parameters
- r: RequestInfo
  
  The {@link RequestInfo} passed to fetch
Returns Promise<T>

Const get

get<T>(uri: string, query?: QueryParams, headers?: HeadersInit): Promise<T>

- Defined in lib/api/fetch.ts:59
Issue a simple get request and return JSON content

Type parameters
- T
Parameters
- uri: string
  
  The URI the GET request will be sent to
- Optional query: QueryParams
  
  Optional query params object
- Optional headers: HeadersInit
Returns Promise<T>

Const getDefaultHeaders

getDefaultHeaders(method: RequestMethod): HeadersInit

- Defined in lib/api/fetch.ts:14
Parameters
- method: RequestMethod
Returns HeadersInit

Const getURI

getURI(uri: string, query?: QueryParams): string

- Defined in lib/api/utils.ts:19
Parameters
- uri: string
- Optional query: QueryParams
Returns string

Const hex

hex(n: number): string

- Defined in lib/qmk/index.ts:9
Convert a numeric vendor or product ID to a hex representation used by QMK

Parameters
- n: number
  
  A numeric vendor ID or product ID
Returns string

Hex string in the format 0x0000

Const isQueryPrimitive

isQueryPrimitive(param: QueryParam): boolean

- Defined in lib/api/utils.ts:8
Parameters
- param: QueryParam
Returns boolean

Const keyboards

keyboards(api: string, ...names: string[]): Promise<KeyboardsResponse>

- Defined in lib/qmk/keyboard.ts:52
Retrieve metadata about keyboards
```
const { git_hash, last_updated, keyboards } = await keyboards('https://api.qmk.fm/v1/', 'massdrop/alt');
```
Parameters
- api: string
  
  The QMK API url
- Rest ...names: string[]
  
  Provide one or more keyboard names, or use the special "all" keyword
Returns Promise<KeyboardsResponse>

Const post

post<T>(uri: string, data?: PostData, query?: QueryParams, headers?: HeadersInit): Promise<T>

- Defined in lib/api/fetch.ts:73
Issue a post request and return the deserialized json response content

Type parameters
- T
Parameters
- uri: string
  
  The URI the POST request will be sent to
- Optional data: PostData
  
  Optional PostData sent to the URI as JSON content
- Optional query: QueryParams
  
  Optional query parameters added to the provided URI
- Optional headers: HeadersInit
Returns Promise<T>

Const readme

readme(api: string, name: string): Promise<string>

- Defined in lib/qmk/keyboard.ts:64
Get the readme file associated with the keyboard

Parameters
- api: string
  
  The QMK API endpoint
- name: string
  The name of the keyboard
```
const altReadme = await readme('https://api.qmk.fm/v1/', 'massdrop/alt');
```
Returns Promise<string>

Const serialize

serialize(data?: PostData): string | undefined

- Defined in lib/api/utils.ts:27
Parameters
- Optional data: PostData
Returns string | undefined

Const serializeQueryParam

serializeQueryParam(__namedParameters: [string, string | number | false | true | (string | number | false | true)[]]): string

- Defined in lib/api/utils.ts:10
Parameters
- __namedParameters: [string, string | number | false | true | (string | number | false | true)[]]
Returns string

Const usb

usb(api: string): Promise<Vendors>

- Defined in lib/qmk/usb.ts:32
Retrieve keyboard metadata by vendor and product ID
```
const vendor = '0x04D8';
const { [vendor]: massdrop } = await usb('https://api.qmk.fm/v1/');
console.info(massdrop);
```
Parameters
- api: string
  
  The QMK API url
Returns Promise<Vendors>

Index

Classes

Type aliases

Variables

Functions

Type aliases

API_VERSION

Key

Type declaration

label: string

x: number

y: number

Keyboard

Type declaration

bootloader: string

description: string

device_ver: string

height: number

identifier: string

keyboard_folder: string

keyboard_name: string

keymaps: string[]

layouts: Layouts

maintainer: string

Optional manufacturer?: undefined | string

platform: string

processor: string

processor_type: string

Optional product_id?: string | number

readme: boolean

url: string

Optional vendor_id?: string | number

width: number

KeyboardMeta

Type declaration

description: string | boolean

keyboard: string

manufacturer: string

product_id: string

vendor_id: string

Keyboards

Type declaration

[name: string]: Keyboard

KeyboardsMeta

Type declaration

[keyboard: string]: KeyboardMeta

KeyboardsResponse

Type declaration

Optional git_hash?: undefined | string

keyboards: Keyboards

last_updated: string

Layout

Type declaration

key_count: number

layout: Key[]

Layouts

Type declaration

[name: string]: Layout

PostData

Products

Type declaration

[productID: string]: KeyboardsMeta

QueryParam

QueryParams

Type declaration

[key: string]: QueryParam

QueryPrimitive

RequestMethod

Vendors

Type declaration

[vendorID: string]: Products

Variables

Const API_ROOT

Headers

Type declaration

constructor: function

Parameters

Optional init: HeadersInit

Returns Headers

prototype: Headers