@humanwhocodes/object-store

Object Store

by Nicholas C. Zakas

If you find this useful, please consider supporting my work with a donation or nominate me for a GitHub Star.

Description

An implementation of an in-memory object store modeled on cloud drives like Google Drive. This is useful mostly for testing purposes.

Usage

Node.js

Install using [npm][npm] or [yarn][yarn]:

npm install @humanwhocodes/object-store

# or

yarn add @humanwhocodes/object-store

Import into your Node.js project:

// CommonJS
const { ObjectStore } = require("@humanwhocodes/object-store");

// ESM
import { ObjectStore } from "@humanwhocodes/object-store";

Deno

Install using JSR:

deno add @humanwhocodes/object-store

#or

jsr add @humanwhocodes/object-store

Then import into your Deno project:

import { ObjectStore } from "@humanwhocodes/object-store";

Bun

Install using this command:

bun add @humanwhocodes/object-store

Import into your Bun project:

import { ObjectStore } from "@humanwhocodes/object-store";

Browser

It's recommended to import the minified version to save bandwidth:

import { ObjectStore } from "https://cdn.skypack.dev/@humanwhocodes/object-store?min";

However, you can also import the unminified version for debugging purposes:

import { ObjectStore } from "https://cdn.skypack.dev/@humanwhocodes/object-store";

API

Creating Files

const store = new ObjectStore();
const file = store.createFile("foo.txt", { content: "Foo", parentId: "folder_id" });

console.log(file);
/*
{
    id: "file_id",
    name: "foo.txt",
    type: "file",
    parent_id: "parent_id",
    created_at: "2022-10-20T12:00:00Z",
    modified_at: "2022-10-20T12:00:00Z",
}
*/

Note: When parentId is omitted, the root folder is used.

Copying Files

const store = new ObjectStore();
const file = store.createFile("foo.txt", { content: "Foo", parentId: "folder_id" });
const copiedFile = store.copyFile(file.id, { parentId: "some_other_folder_id", name: "bar.txt"});
console.log(copiedFile);
/*
{
    id: "copy-file-id",
    name: "bar.txt",
    type: "file",
    parent_id: "some_other_folder_id",
    created_at: "2022-10-20T12:00:00Z",
    modified_at: "2022-10-20T12:00:00Z"
}
*/

Note: name is optional. When parentId is not specified, the ID of the original's parent is used.

Moving/Renaming Files

const store = new ObjectStore();
const file = store.createFile("foo.txt", { content: "Foo", parentId: "folder_id" });
const updatedFile = store.updateFile(file.id, { parentId: "some_other_folder_id", name: "bar.txt"});
console.log(updatedFile);
/*
{
    id: "file-id",
    name: "bar.txt",
    type: "file",
    parent_id: "some_other_folder_id",
    created_at: "2022-10-20T12:00:00Z",
    modified_at: "2022-10-20T12:00:00Z"
}
*/

Note: Both name and parentId are optional.

Retrieving Files

const store = new ObjectStore();
const file = store.createFile("foo.txt", { content: "Foo" });
const retrievedFile = store.getFile(file.id);
console.log(retrievedFile);
/*
{
    id: "file_id",
    name: "foo.txt",
    type: "file",
    parent_id: "parent_id",
    created_at: "2022-10-20T12:00:00Z",
    modified_at: "2022-10-20T12:00:00Z",
}
*/

Retrieving File Content

const store = new ObjectStore();
const file = store.createFile("foo.txt", { content: "Foo" });
const content = store.getFileContent(file.id);
console.log(content);   // "Foo"

Deleting Files

const store = new ObjectStore();
const file = store.createFile("foo.txt", { content: "Foo" });

store.deleteFile(file.id);

Creating Folders

const store = new ObjectStore();
const folder = store.createFolder("my-folder", { parentId: "parent_folder_id" });
console.log(folder);
/*
{
    id: "folder_id",
    name: "my-folder",
    type: "folder",
    parent_id: "parent_id",
    created_at: "2022-10-20T12:00:00Z",
    modified_at: "2022-10-20T12:00:00Z",
    entries: []
}
*/

Note: When parentId is omitted, the root folder is used.

Copying Folders

const store = new ObjectStore();
const folder = store.createFolder("my-folder", { parentId: "parent_folder_id" });
const copiedFolder = store.copyFolder(folder.id, { parentId: "some_other_folder_id", name: "my-folder-copy"});
console.log(copiedFolder);
/*
{
    id: "folder_copy_id",
    name: "my-folder-copy",
    type: "folder",
    parent_id: "some_other_folder_id",
    created_at: "2022-10-20T12:00:00Z",
    modified_at: "2022-10-20T12:00:00Z",
    entries: []
}
*/

Note: name is optional. When parentId is not specified, the ID of the original's parent is used.

Moving/Renaming Folders

const store = new ObjectStore();
const folder = store.createFolder("my-folder", { parentId: "parent_folder_id" });
const updatedFolder = store.updateFolder(file.id, { parentId: "some_other_folder_id", name: "my-new-name"});
console.log(updatedFolder);
/*
{
    id: "folder_id",
    name: "my-new-name",
    type: "folder",
    parent_id: "some_other_folder_id",
    created_at: "2022-10-20T12:00:00Z",
    modified_at: "2022-10-20T12:00:00Z",
    entries: []
}
*/

Deleting Folders

const store = new ObjectStore();
const folder = store.createFolder("my-folder");

store.deleteFolder(folder.id);

Developer Setup

1. Fork the repository
2. Clone your fork
3. Run npm install to setup dependencies
4. Run npm test to run tests

License

Apache 2.0