From 85200778a1014760a0e6bf26a963d63151b78d2b Mon Sep 17 00:00:00 2001 From: GoneTone Date: Wed, 7 Dec 2022 09:31:22 +0800 Subject: [PATCH] docs: usage in CommonJS (dynamic import) --- readme.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/readme.md b/readme.md index 5d188a9..bad67fd 100644 --- a/readme.md +++ b/readme.md @@ -60,6 +60,29 @@ const api = new ChatGPTAPI({ }) ``` +Usage in CommonJS (Dynamic import): + +```js +async function example() { + // use ESM in CommonJS, dynamic import + const { ChatGPTAPI } = await import('chatgpt') + + // sessionToken is required; see below for details + const api = new ChatGPTAPI({ sessionToken: process.env.SESSION_TOKEN }) + + // ensure the API is properly authenticated + await api.ensureAuth() + + // send a message and wait for the response + const response = await api.sendMessage( + 'Write a python version of bubble sort. Do not include example usage.' + ) + + // response is a markdown-formatted string + console.log(response) +} +``` + A full [demo](./src/demo.ts) is included for testing purposes: ```bash