From cd5da89ddfb5fc4d0719f59bf3c63e66b5bd5f83 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 18 Jul 2024 16:37:06 +0000 Subject: [PATCH] chore(docs): use client instead of package name in Node examples (#236) --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6ea7d7c..451d774 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ The full API of this library can be found in [api.md](api.md). ```js import Orb from 'orb-billing'; -const orb = new Orb({ +const client = new Orb({ apiKey: process.env['ORB_API_KEY'], // This is the default and can be omitted }); @@ -41,7 +41,7 @@ This library includes TypeScript definitions for all request params and response ```ts import Orb from 'orb-billing'; -const orb = new Orb({ +const client = new Orb({ apiKey: process.env['ORB_API_KEY'], // This is the default and can be omitted }); @@ -104,7 +104,7 @@ You can use the `maxRetries` option to configure or disable this: ```js // Configure the default for all requests: -const orb = new Orb({ +const client = new Orb({ maxRetries: 0, // default is 2 }); @@ -121,7 +121,7 @@ Requests time out after 1 minute by default. You can configure this with a `time ```ts // Configure the default for all requests: -const orb = new Orb({ +const client = new Orb({ timeout: 20 * 1000, // 20 seconds (default is 1 minute) }); @@ -176,7 +176,7 @@ You can also use the `.withResponse()` method to get the raw `Response` along wi ```ts -const orb = new Orb(); +const client = new Orb(); const response = await orb.customers .create({ email: 'example-customer@withorb.com', name: 'My Customer' }) @@ -287,7 +287,7 @@ import http from 'http'; import { HttpsProxyAgent } from 'https-proxy-agent'; // Configure the default for all requests: -const orb = new Orb({ +const client = new Orb({ httpAgent: new HttpsProxyAgent(process.env.PROXY_URL), });