dat-jsondeprecated

read & write dat.json files

Usage no npm install needed!

<script type="module">
  import datJson from 'https://cdn.skypack.dev/dat-json';
</script>

README

deprecated

More info on active projects and modules at dat-ecosystem.org

dat-json

read & write dat.json files. Uses toiletdb under the hood.

npm travis standard

Install

npm install dat-json

Usage

var DatJSON = require('dat-json')

var datjson = DatJSON(archive)

await datjson.create({title: 'a dat', description: 'exciting'})

console.log(await datjson.read())

Write to a dat.json on the file system also:

var DatJSON = require('dat-json')

var datjson = DatJSON(archive, {file: path.join(dat.path, 'dat.json')})

await datjson.create({title: 'a dat', description: 'exciting'})

TODO: replace file option with hyperdrive indexing

API

var datjson = DatJSON(archive, [opts])

create a new datJson db

Options:

  • opts.file - dat.json file path, updates will be written to file system and archive

await datjson.create([data])

Create a new dat.json file in the archive with the default keys (url, title, description). Pass in any additional data to add on initial create.

await datjson.write(key, val) or await datjson.write(data)

Write a single key and value or an object, data, to the dat.json file. Use file option above to also update the file on the file system.

await datjson.delete(key)

Delete a key from the dat.json file.

await datjson.read()

Read the current dat.json.

License

MIT