jayant-nitj-crud
v1.0.1
Published
A library to interact with the CRUD platform API
Readme
jayant-nitj-crud
A simple library to interact with the CRUD platform API.
Installation
npm install jayant-nitj-crudUsage
Setting up environment variables
Create a .env file in your project root with:
CRUD_API_URL=your_api_url_here
CRUD_API_KEY=your_api_key_hereOr configure the library programmatically:
const { config, create, get, update, delete_ } = require('jayant-nitj-crud');
// Configure the library
config({
apiUrl: 'your_api_url_here',
apiKey: 'your_api_key_here'
});
// Now you can use the library functionsAPI Reference
CrudClient
The main class for interacting with the CRUD API.
Methods
- getData() - Retrieves data from the API
- createData(data) - Creates new data
- updateData(id, data) - Updates existing data
- deleteData(id) - Deletes data
Example
const { create, get, update, delete_ } = require('jayant-nitj-crud');
// Create a new item
async function createItem() {
const result = await create({
value: 100,
txHash: 'abc123'
});
if (result.error) {
console.error('Error:', result.error);
} else {
console.log('Created item:', result.data);
}
}
// Get an item
async function getItem(id) {
const result = await get(id);
if (result.error) {
console.error('Error:', result.error);
} else {
console.log('Item:', result.data);
}
}
// Update an item
async function updateItem(id) {
const result = await update(id, {
value: 200
});
if (result.error) {
console.error('Error:', result.error);
} else {
console.log('Updated item:', result.data);
}
}
// Delete an item
async function deleteItem(id) {
const result = await delete_(id);
if (result.error) {
console.error('Error:', result.error);
} else {
console.log('Deleted item:', result.message);
}
}