@robinpath/sanity
v0.1.1
Published
Sanity module for RobinPath.
Readme
@robinpath/sanity
Sanity module for RobinPath.
Why use this module?
The sanity module lets you:
- query
- getDocument
- createDocument
- createOrReplace
- patch
All functions are callable directly from RobinPath scripts with a simple, consistent API.
Installation
npm install @robinpath/sanityQuick Start
1. Set up credentials
sanity.setCredentials "your-credentials"2. query
sanity.queryAvailable Functions
| Function | Description |
|----------|-------------|
| sanity.setCredentials | Configure sanity credentials. |
| sanity.query | query |
| sanity.getDocument | getDocument |
| sanity.createDocument | createDocument |
| sanity.createOrReplace | createOrReplace |
| sanity.patch | patch |
| sanity.deleteDocument | deleteDocument |
| sanity.uploadAsset | uploadAsset |
| sanity.getAsset | getAsset |
| sanity.listDatasets | listDatasets |
| sanity.createDataset | createDataset |
| sanity.deleteDataset | deleteDataset |
| sanity.mutate | mutate |
| sanity.listDocumentsByType | listDocumentsByType |
| sanity.getProject | getProject |
| sanity.exportDataset | exportDataset |
| sanity.importDataset | importDataset |
Examples
query
sanity.querygetDocument
sanity.getDocumentcreateDocument
sanity.createDocumentIntegration with RobinPath
import { RobinPath } from "@wiredwp/robinpath";
import Module from "@robinpath/sanity";
const rp = new RobinPath();
rp.registerModule(Module.name, Module.functions);
rp.registerModuleMeta(Module.name, Module.functionMetadata);
const result = await rp.executeScript(`
sanity.setCredentials "your-credentials"
sanity.query
`);Full API Reference
See MODULE.md for complete documentation including all parameters, return types, error handling, and advanced examples.
Related Modules
@robinpath/json— JSON module for complementary functionality
License
MIT
