@@ -137,15 +137,15 @@ run();
137137
138138* [ list] ( docs/sdks/customers/README.md#list ) - Retrieve a list of customers
139139* [ get] ( docs/sdks/customers/README.md#get ) - Retrieve a customer
140- * [ update] ( docs/sdks/customers/README.md#update ) - Update a customer
141140* [ delete] ( docs/sdks/customers/README.md#delete ) - Delete a customer
141+ * [ update] ( docs/sdks/customers/README.md#update ) - Update a customer
142142
143143### [ Domains] ( docs/sdks/domains/README.md )
144144
145- * [ create] ( docs/sdks/domains/README.md#create ) - Create a domain
146145* [ list] ( docs/sdks/domains/README.md#list ) - Retrieve a list of domains
147- * [ update ] ( docs/sdks/domains/README.md#update ) - Update a domain
146+ * [ create ] ( docs/sdks/domains/README.md#create ) - Create a domain
148147* [ delete] ( docs/sdks/domains/README.md#delete ) - Delete a domain
148+ * [ update] ( docs/sdks/domains/README.md#update ) - Update a domain
149149* [ register] ( docs/sdks/domains/README.md#register ) - Register a domain
150150* [ checkStatus] ( docs/sdks/domains/README.md#checkstatus ) - Check the availability of one or more domains
151151
@@ -159,30 +159,30 @@ run();
159159
160160### [ Folders] ( docs/sdks/folders/README.md )
161161
162- * [ create] ( docs/sdks/folders/README.md#create ) - Create a folder
163162* [ list] ( docs/sdks/folders/README.md#list ) - Retrieve a list of folders
164- * [ update ] ( docs/sdks/folders/README.md#update ) - Update a folder
163+ * [ create ] ( docs/sdks/folders/README.md#create ) - Create a folder
165164* [ delete] ( docs/sdks/folders/README.md#delete ) - Delete a folder
165+ * [ update] ( docs/sdks/folders/README.md#update ) - Update a folder
166166
167167### [ Links] ( docs/sdks/links/README.md )
168168
169- * [ create] ( docs/sdks/links/README.md#create ) - Create a link
170169* [ list] ( docs/sdks/links/README.md#list ) - Retrieve a list of links
170+ * [ create] ( docs/sdks/links/README.md#create ) - Create a link
171171* [ count] ( docs/sdks/links/README.md#count ) - Retrieve links count
172172* [ get] ( docs/sdks/links/README.md#get ) - Retrieve a link
173- * [ update] ( docs/sdks/links/README.md#update ) - Update a link
174173* [ delete] ( docs/sdks/links/README.md#delete ) - Delete a link
174+ * [ update] ( docs/sdks/links/README.md#update ) - Update a link
175175* [ createMany] ( docs/sdks/links/README.md#createmany ) - Bulk create links
176- * [ updateMany] ( docs/sdks/links/README.md#updatemany ) - Bulk update links
177176* [ deleteMany] ( docs/sdks/links/README.md#deletemany ) - Bulk delete links
177+ * [ updateMany] ( docs/sdks/links/README.md#updatemany ) - Bulk update links
178178* [ upsert] ( docs/sdks/links/README.md#upsert ) - Upsert a link
179179
180180### [ Partners] ( docs/sdks/partners/README.md )
181181
182- * [ create] ( docs/sdks/partners/README.md#create ) - Create or update a partner
183182* [ list] ( docs/sdks/partners/README.md#list ) - List all partners
184- * [ createLink ] ( docs/sdks/partners/README.md#createlink ) - Create a link for a partner
183+ * [ create ] ( docs/sdks/partners/README.md#create ) - Create or update a partner
185184* [ retrieveLinks] ( docs/sdks/partners/README.md#retrievelinks ) - Retrieve a partner's links.
185+ * [ createLink] ( docs/sdks/partners/README.md#createlink ) - Create a link for a partner
186186* [ upsertLink] ( docs/sdks/partners/README.md#upsertlink ) - Upsert a link for a partner
187187* [ analytics] ( docs/sdks/partners/README.md#analytics ) - Retrieve analytics for a partner
188188* [ ban] ( docs/sdks/partners/README.md#ban ) - Ban a partner
@@ -198,10 +198,10 @@ run();
198198
199199### [ Tags] ( docs/sdks/tags/README.md )
200200
201- * [ create] ( docs/sdks/tags/README.md#create ) - Create a tag
202201* [ list] ( docs/sdks/tags/README.md#list ) - Retrieve a list of tags
203- * [ update ] ( docs/sdks/tags/README.md#update ) - Update a tag
202+ * [ create ] ( docs/sdks/tags/README.md#create ) - Create a tag
204203* [ delete] ( docs/sdks/tags/README.md#delete ) - Delete a tag
204+ * [ update] ( docs/sdks/tags/README.md#update ) - Update a tag
205205
206206### [ Track] ( docs/sdks/track/README.md )
207207
@@ -236,9 +236,11 @@ const dub = new Dub({
236236
237237async function run() {
238238 try {
239- const result = await dub .links .create ();
239+ const result = await dub .links .list ();
240240
241- console .log (result );
241+ for await (const page of result ) {
242+ console .log (page );
243+ }
242244 } catch (error ) {
243245 // The base class for HTTP error responses
244246 if (error instanceof errors .DubError ) {
@@ -305,9 +307,11 @@ const dub = new Dub({
305307});
306308
307309async function run() {
308- const result = await dub .links .create ();
310+ const result = await dub .links .list ();
309311
310- console .log (result );
312+ for await (const page of result ) {
313+ console .log (page );
314+ }
311315}
312316
313317run ();
@@ -328,19 +332,23 @@ The `HTTPClient` constructor takes an optional `fetcher` argument that can be
328332used to integrate a third-party HTTP client or when writing tests to mock out
329333the HTTP client and feed in fixtures.
330334
331- The following example shows how to use the ` "beforeRequest" ` hook to to add a
332- custom header and a timeout to requests and how to use the ` "requestError" ` hook
333- to log errors:
335+ The following example shows how to:
336+ - route requests through a proxy server using [ undici] ( https://www.npmjs.com/package/undici ) 's ProxyAgent
337+ - use the ` "beforeRequest" ` hook to add a custom header and a timeout to requests
338+ - use the ` "requestError" ` hook to log errors
334339
335340``` typescript
336341import { Dub } from " dub" ;
342+ import { ProxyAgent } from " undici" ;
337343import { HTTPClient } from " dub/lib/http" ;
338344
345+ const dispatcher = new ProxyAgent (" http://proxy.example.com:8080" );
346+
339347const httpClient = new HTTPClient ({
340- // fetcher takes a function that has the same signature as native ` fetch` .
341- fetcher : (request ) => {
342- return fetch ( request );
343- }
348+ // ' fetcher' takes a function that has the same signature as native ' fetch' .
349+ fetcher : (input , init ) =>
350+ // 'dispatcher' is specific to undici and not part of the standard Fetch API.
351+ fetch ( input , { ... init , dispatcher } as RequestInit ),
344352});
345353
346354httpClient .addHook (" beforeRequest" , (request ) => {
@@ -384,9 +392,11 @@ const dub = new Dub({
384392});
385393
386394async function run() {
387- const result = await dub .links .create ();
395+ const result = await dub .links .list ();
388396
389- console .log (result );
397+ for await (const page of result ) {
398+ console .log (page );
399+ }
390400}
391401
392402run ();
@@ -408,7 +418,7 @@ const dub = new Dub({
408418});
409419
410420async function run() {
411- const result = await dub .links .create ( {
421+ const result = await dub .links .list ( undefined , {
412422 retries: {
413423 strategy: " backoff" ,
414424 backoff: {
@@ -421,7 +431,9 @@ async function run() {
421431 },
422432 });
423433
424- console .log (result );
434+ for await (const page of result ) {
435+ console .log (page );
436+ }
425437}
426438
427439run ();
@@ -447,9 +459,11 @@ const dub = new Dub({
447459});
448460
449461async function run() {
450- const result = await dub .links .create ();
462+ const result = await dub .links .list ();
451463
452- console .log (result );
464+ for await (const page of result ) {
465+ console .log (page );
466+ }
453467}
454468
455469run ();
0 commit comments