{"id":20963845,"url":"https://github.com/codemix/reign","last_synced_at":"2025-05-14T09:31:40.245Z","repository":{"id":57352581,"uuid":"51880393","full_name":"codemix/reign","owner":"codemix","description":"A persistent, typed objects implementation for node.js and the browser.","archived":false,"fork":false,"pushed_at":"2016-03-26T19:29:49.000Z","size":180,"stargazers_count":23,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-05-04T03:34:36.471Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codemix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-02-17T00:10:03.000Z","updated_at":"2022-12-09T04:10:33.000Z","dependencies_parsed_at":"2022-09-16T08:20:55.854Z","dependency_job_id":null,"html_url":"https://github.com/codemix/reign","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codemix%2Freign","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codemix%2Freign/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codemix%2Freign/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codemix%2Freign/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codemix","download_url":"https://codeload.github.com/codemix/reign/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254112259,"owners_count":22016721,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T02:48:35.833Z","updated_at":"2025-05-14T09:31:35.232Z","avatar_url":"https://github.com/codemix.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# reign\nPersistent, typed objects for JavaScript.\n\n[![Build Status](https://travis-ci.org/codemix/reign.svg?branch=master)](https://travis-ci.org/codemix/reign)\n\n## What?\n\nProvides a realm (like a namespace) which can contain various kinds of typed object, and mechanisms for\nstoring and loading those objects to disk.\n\nCurrently supports various kinds of data type:\n\n* [Arrays](./src/type-class/array-type)\n* [HashMaps](./src/type-class/hash-map-type)\n* [HashSets](./src/type-class/hash-set-type)\n* [Objects](./src/type-class/object-type)\n* [Primitives](./src/type-class/primitive-type)\n* [References](./src/type-class/reference-type)\n* [Strings](./src/type-class/string-type)\n* [Structs](./src/type-class/struct-type)\n* [Enums](./src/type-class/enum-type)\n* [Unions](./src/type-class/union-type)\n\nAs well as the following builtins:\n\n* [T.Any](./src/builtins/any)\n* [T.Array](./src/builtins/array)\n* [T.Boolean](./src/builtins/boolean)\n* [T.Int8](./src/builtins/int8)\n* [T.Int16](./src/builtins/int16)\n* [T.Int32](./src/builtins/int32)\n* [T.Uint8](./src/builtins/uint8)\n* [T.Uint16](./src/builtins/uint16)\n* [T.Uint32](./src/builtins/uint32)\n* [T.Float32](./src/builtins/float32)\n* [T.Float64](./src/builtins/float64)\n* [T.HashMap](./src/builtins/hash-map)\n* [T.HashSet](./src/builtins/hash-set)\n* [T.Object](./src/builtins/object)\n* [T.String](./src/builtins/string)\n* [T.InternedString](./src/builtins/interned-string)\n\n\n## Examples\n\nSee the [examples](./examples) directory.\n\n## API Documentation\n\nCurrently very work in progress, see [src/README.md](./src/README.md).\n\n## Installation\n\nInstall via [npm](https://npmjs.org/package/reign).\n```sh\nnpm install reign\n```\n\n## Usage\n```js\nvar Backing = require('backing');\nvar Realm = require('reign').Realm;\n\nvar backing = new Backing({\n  name: 'example',\n  arenaSize: 1024 * 1024,\n  arenaSource: {\n    type: 'mmap', // can also be 'array-buffer' to use storage which will not survive program termination.\n    dirname: __dirname + '/../data'\n  }\n});\n\nvar realm = new Realm(backing);\n\n// `T` is an object containing all the registered types in the realm, e.g. `T.String` or `T.Object`.\nvar T = realm.T;\n\nvar StructType = realm.StructType;\n\n// Initialize the realm, loading the data files. (Returns a promise)\nrealm.init().then(function () {\n  const Thing = new StructType({\n    id: T.Uint32,\n    name: T.String,\n    description: T.String,\n    extra: T.Object // Holds additional properties.\n  });\n\n  let thing = realm.get('London');\n  if (!thing) {\n    // This must be the first time we've run this program.\n    thing = new Thing({\n      id: 123,\n      name: 'London',\n      description: 'The city of london.',\n      extra: {\n        type: 'Place'\n      }\n    });\n    console.log('Saving a new Thing called London');\n    realm.set('London', thing);\n  }\n  else {\n    console.log('Loaded an existing thing called London')\n  }\n\n  console.log(JSON.stringify(thing, null, 2));\n\n  if (thing.extra.type !== 'City') {\n    console.log('London is a city, not just a place.')\n    thing.extra.type = 'City';\n  }\n\n});\n```\nRun this example more than once to see different results.\n\n## License\n\nPublished by [codemix](http://codemix.com/) under a permissive MIT License, see [LICENSE.md](./LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodemix%2Freign","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodemix%2Freign","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodemix%2Freign/lists"}