docs: add examples

examples/custom-caching/README.md

@@ -9,6 +9,15 @@ Remember that in the browser, caching is enabled by default by using the global
 function. Browsers will automatically utilize their caching mechanism unless it
 is disabled by a user.
 
+**Note**: This example is written for Node.js. If you plan to use this code for
+the browser, you can remove `node-fetch` from the example.
+
+```diff
+   import * as prismic from '@prismicio/client'
+-  import fetch from 'node-fetch'
+   import QuickLRU from 'quick-lru'
+```
+
 ## How to run the example
 
 ```sh

examples/custom-caching/index.js

@@ -1,13 +1,13 @@
 import * as prismic from '@prismicio/client'
+import fetch from 'node-fetch'
 import QuickLRU from 'quick-lru'
 
-const endpoint = prismic.getEndpoint('my-repo')
+const endpoint = prismic.getEndpoint('qwerty')
 const cache = new QuickLRU({
-  maxAge: 10000, // 10 seconds
   maxSize: 1000, // 1000 entries
 })
 
-export const client = prismic.createClient(endpoint, {
+const client = prismic.createClient(endpoint, {
   fetch: async (url, options) => {
     // The cache key contains the requested URL and headers
     const key = JSON.stringify({ url, options })
@@ -30,9 +30,9 @@ export const client = prismic.createClient(endpoint, {
 })
 
 const homepage = await client.getByUID('page', 'home')
-console.log(homepage)
+console.log('First uncached result: ', homepage)
 // => The `page` document with a UID of `home`
 
 const homepageFetchedAgain = await client.getByUID('page', 'home')
-console.log(homepageFetchedAgain)
+console.log('Second cached result: ', homepageFetchedAgain)
 // => This call will use the cache rather than make another network request.

examples/custom-caching/package.json

@@ -1,6 +1,8 @@
 {
+  "type": "module",
   "dependencies": {
     "@prismicio/client": "^5.0.0",
+    "node-fetch": "^2.6.1",
     "quick-lru": "^6.0.0"
   }
 }

examples/server-usage/README.md

@@ -0,0 +1,31 @@
+# Server Usage
+
+This example shows how to use `@prismicio/client` on the server. Usage is
+identical to usage in the browser, except for the need to provide a `fetch()`
+function.
+
+In this example, we're using a library called [node-fetch][node-fetch] to make
+network requests. This is a nearly drop-in Node.js implementation for the
+browser's `fetch()` function.
+
+For our use-case, its only limitation is the lack of built-in caching. If you
+are running in a serverless architecture where instances are started and stopped
+per-request, caching is unnecessary. If you are running on a long-living server,
+caching would be beneficial. See the [Custom Caching](../custom-caching) example
+to see how to setup caching.
+
+## How to run the example
+
+```sh
+# Clone the repository to your computer
+git clone https://github.com/prismicio/prismic-javascript.git
+cd prismic-javascript/examples/server-usage
+
+# Install the dependencies
+npm install
+
+# Run the example
+node index.js
+```
+
+[node-fetch]: https://github.com/node-fetch/node-fetch

examples/server-usage/index.js

@@ -1,14 +1,11 @@
 import * as prismic from '@prismicio/client'
-import got from 'got'
+import fetch from 'node-fetch'
 
-const endpoint = prismic.getEndpoint('my-repo')
+const endpoint = prismic.getEndpoint('qwerty')
 const client = prismic.createClient(endpoint, {
   // Here, we provide a way for the client to make network requests.
-  // Got is one way to make network requests on the server. It has built-in
-  // caching and automatically retries requests on failures.
-  fetch: async (url, options) => {
-    return await got(url, options).json()
-  },
+  // `node-fetch` is a Node.js fetch-compatible package.
+  fetch,
 })
 
 const homepage = await client.getByUID('page', 'home')