From c0dccd6bb949b6b7645ebb66f2147fec99078fbc Mon Sep 17 00:00:00 2001 From: ckohen Date: Tue, 2 May 2023 14:40:29 -0700 Subject: [PATCH] docs: update to reflect recent changes --- packages/rest/README.md | 19 +++++++++++++++++++ packages/rest/src/lib/REST.ts | 3 ++- 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/packages/rest/README.md b/packages/rest/README.md index 11d65ba6ed9e7..b30996a236fc7 100644 --- a/packages/rest/README.md +++ b/packages/rest/README.md @@ -79,6 +79,25 @@ try { } ``` +Send a basic message in an edge environment: + +```js +import { REST } from '@discordjs/rest'; +import { Routes } from 'discord-api-types/v10'; + +const rest = new REST({ version: '10', makeRequest: fetch }).setToken(TOKEN); + +try { + await rest.post(Routes.channelMessages(CHANNEL_ID), { + body: { + content: 'A message via REST from the edge!', + }, + }); +} catch (error) { + console.error(error); +} +``` + ## Links - [Website][website] ([source][website-source]) diff --git a/packages/rest/src/lib/REST.ts b/packages/rest/src/lib/REST.ts index 42144c1b691f8..abfc06560a6e8 100644 --- a/packages/rest/src/lib/REST.ts +++ b/packages/rest/src/lib/REST.ts @@ -83,8 +83,9 @@ export interface RESTOptions { invalidRequestWarningInterval: number; /** * The method called to perform the actual HTTP request given a url and web `fetch` options + * For example, to use global fetch, simply provide `makeRequest: fetch` * - * @defaultValue `fetch` + * @defaultValue `undici.request` */ makeRequest(url: string, init: RequestInit): Promise; /**