orbitdb/orbit-db
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #693 from spartanz51/master

Browse Source 
fix custom access controller example
This commit is contained in:
shamb0t 2019-09-23 09:05:50 +01:00 committed by GitHub
commit 66924be133
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
GUIDE.md
View File

@ -280,6 +280,9 @@ await db.access.grant('write', identity2.publicKey) // grant access to identity2
You can create a custom access controller by implementing the `AccessController` [interface](https://github.com/orbitdb/orbit-db-access-controllers/blob/master/src/access-controller-interface.js) and adding it to the AccessControllers object before passing it to OrbitDB.
```javascript
let AccessControllers = require('orbit-db-access-controllers')
const AccessController = require('orbit-db-access-controllers/src/access-controller-interface')
class OtherAccessController extends AccessController {
static get type () { return 'othertype' } // Return the type for this controller
@ -293,9 +296,17 @@ class OtherAccessController extends AccessController {
}
async grant (access, identity) {} // Logic for granting access to identity
async save () {
// return parameters needed for loading
return { parameter: 'some-parameter-needed-for-loading' }
}
static async create (orbitdb, options) {
return new OtherAccessController()
}
}
let AccessControllers = require('orbit-db-access-controllers')
AccessControllers.addAccessController({ AccessController: OtherAccessController })
const orbitdb = await OrbitDB.createInstance(ipfs, {
@ -305,7 +316,7 @@ const orbitdb = await OrbitDB.createInstance(ipfs, {
const db = await orbitdb.keyvalue('first-database', {
accessController: {
type: 'othertype',
write: [id1.publicKey]
write: [id1.id]
}
})
```