This is a Universal Javascript client for the Perkeep storage system.
npm install perkeepThe library supports saving data using either a username/password or a username/vivify-password which does not allow signing schemas. An example of both use cases is shown below. The upload method should accept just about any type of data (in the browser or in Node). e.g. Blobs, Buffers, TypedArrays, JSON, or Strings.
const Perkeep = require('perkeep');
let perkeep = Perkeep({
host: 'http://perkeep.test',
user: 'user',
password: 'pass'
});
let data = fs.readFileSync('demo.txt');
perkeep.discover()
.then(function (discoveryConfig) {
perkeep.discoveryConfig = discoveryConfig;
return perkeep.upload(data);
})
.then(function(parts) {
let fileSchema = {
"camliVersion": 1,
"camliType": "file",
"unixMTime": new Date(Date.now()).toISOString(),
"fileName": "demo.txt",
parts
};
return perkeep.sign(fileSchema).then(signature => perkeep.upload(signature));
})
.then(function(received) {
return perkeep.createPermanode({
title: "NodeJS Title",
camliContent: received[0].blobRef
});
})
.then(function({ permanodeRef }) {
console.log(`Created ${permanodeRef}`);
});let perkeep = Perkeep({
host: 'http://perkeep.test',
user: 'user',
vivify: 'rainbows'
});
let data = new Blob(["This is my blob content"], {type : "text/plain"});
perkeep.discover()
.then(function(discoveryConfig) {
perkeep.discoveryConfig = discoveryConfig;
return perkeep.upload(data);
})
.then(function (parts) {
let fileSchema = {
"camliVersion": 1,
"camliType": "file",
"unixMTime": new Date(Date.now()).toISOString(),
"fileName": "demo.txt",
parts
};
return perkeep.upload(fileSchema);
});npm run build builds the library to dist, generating three files:
dist/perkeep.cjs.jsA CommonJS bundle, suitable for use in Node.js, thatrequires the external dependencies. This corresponds to the"main"field in package.jsondist/perkeep.esm.jsan ES module bundle, suitable for use in other people's libraries and applications, thatimports the external dependency. This corresponds to the"module"field in package.jsondist/perkeep.iife.jsa IIFE build, suitable for use in the browser, as a<script>tag, that includes the external dependencies. This corresponds to the"browser"field in package.json
npm run dev builds the library, then keeps rebuilding it whenever the source files change using rollup-watch.
npm test builds the library, then tests it.
- Make the "Building and Running Tests" section real.
- Document Perkeep class API.
- Add data uri parsing to
uploadsupport. - Add ability to search and query.
MIT.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent