README.md

Entities

A library for managing Entity contexts for Holochain CRUD patterns.

Install

npm i @spartan-hc/entities

Basic Usage

import crypto from 'crypto';
import { ActionHash, EntryHash } from '@spartan-hc/holo-hash';
import { Entity } from '@spartan-hc/entities';

const post = new Entity({
    "id": new ActionHash( crypto.randomBytes(32) ),
    "action": new ActionHash( crypto.randomBytes(32) ),
    "address": new EntryHash( crypto.randomBytes(32) ),
    "type": "post",
    "content": {
        "message": "Goodbye, world!",
        "published_at": 1696819762583,
        "last_updated": 1696819762602
    }
});

console.log( post );
// Entity {
//     message: 'Goodbye, world!',
//     published_at: 1696819762583,
//     last_updated: 1696819762602
// }

// Hidden properties
console.log( post.$id );        // ActionHash( ... );
console.log( post.$action );    // ActionHash( ... );
console.log( post.$address );   // EntryHash( ... );
console.log( post.$type );      // "post"