@unofficialbox/box-open-sdk 0.1.0

package/docs/pagination.md

@@ -0,0 +1,17 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# Pagination
+
+Marker- and offset-paginated list operations return an `AsyncIterableIterator`
+that yields one entry at a time, threading the cursor for you — the list method
+*is* the paginator, so drive it directly with `for await ... of`:
+
+```ts
+for await (const item of client.folders.listItems(folderId)) {
+// use item
+}
+```
+
+It walks every page until the response has no next cursor (or an empty page, for
+offset pagination), and owns a private copy of the options you pass, so your
+value is never mutated. The wire cursor (`next_marker` / `offset`, verbatim per
+TR-TS.2) is threaded through the options for you.

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@unofficialbox/box-open-sdk",
+  "version": "0.1.0",
+  "description": "Generated TypeScript SDK for the Box API (community, unofficial).",
+  "license": "MIT",
+  "repository": { "type": "git", "url": "git+https://github.com/unofficialbox/box-open-ts-sdk.git" },
+  "homepage": "https://github.com/unofficialbox/box-open-ts-sdk",
+  "type": "module",
+  "sideEffects": false,
+  "engines": { "node": ">=20" },
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./jwt": {
+      "types": "./dist/types/jwt.d.ts",
+      "import": "./dist/esm/jwt.js",
+      "require": "./dist/cjs/jwt.js"
+    }
+  },
+  "files": ["dist", "docs", "README.md"],
+  "publishConfig": { "access": "public" },
+  "devDependencies": { "typescript": "^7.0.2" },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json && tsc -p tsconfig.cjs.json && node scripts/postbuild.mjs"
+  }
+}