API Reference

Initialize PrefsDB instance

<script src="https://prefsdb.com/prefsdb.com.js"></script>

Write Data

---

         .write( data [, options])

         .post( data [, options])

         .setItem( item [, options])

         .putObject( object [, options])

         .add( item [, options])

.write

    [Promise promise = ] .write(data [, options])

.key

    [Promise promise = ] .key('itemid').write(data [, options])

.post

    [Promise promise = ] .post(data [, options])

.setItem

    [Promise promise = ] .setItem('key' [, options])

.putObject

    [Promise promise = ] .putObject('path/key' [, options])

.add

    [Promise promise = ] .list('name').add(data [, options])

Read Data

---

         .read( [options] )

         .readAll( [options] )

         .getItem( [options] )

         .getObject( [options] )

.read

    [Promise promise = ] .read( [options] )

.readAll

    [Promise promise = ] .read( [options] )

.key

    [Promise promise = ] .key('itemid').read( [options] )

.match

    [Promise promise = ] .list('name').match('pattern').read([options])

.getItem

    [Promise promise = ] .getItem('key' [, options])

.getObject

    [Promise promise = ] .getObject('path/key' [, options])

Filtering results

---

         .match( 'pattern' )

.match

    [Promise promise = ] .list('name').match('pattern').read([options])

Remove all values from a list named "mystuff" that being with 2025.

.list("mystuff").match("2025%").delete()

Organizing data

---

         .project( 'name' )

         .domain( 'name' )

         .subdomain( 'name' )

.project

    .project('myapp').write(data);
    .project('myapp').read( { onsuccess: (resp)=>{ data=resp.value; } );

.domain

    .project('myapp').domain('display').write(settings);
    .project('myapp').domain('display').read({ 
        onsuccess: (resp)=>{ 
            settings=resp.values; 
        });

.subdomain

    .project('myapp')
        .domain('display')
        .subdomain('accessability')
        .write(settings);

    .project('myapp')
        .domain('display')
        .subdomain('accessability')
        .read({ 
            onsuccess: (resp)=>{ 
                settings=resp.values; 
            }
        });

Delete data

---

         .delete( [options] )

         .ttl( days )

.delete

Delete a entry (a value) assigned to a key named "name"

.key("name").delete([options])

Remove a specific "value" from a list named "mystuff".

.list("mystuff").delete("value")

See: Remove data

.ttl

Set max time-to-live directive for a value in days.

    [Promise promise = ] .ttl(30).key('foobar').write('data' [, options])

API Keys / tokens

---

         .getkey('keyname', seed [ ] [, options] )

         .createkey( 'keyname', seed [ ] [, options] )

.getkey

Creates a new key using parameters provided or returns the key, if one already exists.

    [Promise promise = ] .getkey('keyname' , [ 'a', 'b', ...] [, options])

.createkey

Creates a new key using parameters provided. Returns a failed response , if a key already exists.

    [Promise promise = ] .createkey('keyname' , [ 'a', 'b', ...] [, options])

Options

---

onsuccess

    onsuccess: (result) => {
        console.log("%o", result);
    }

onerror

    onerror: (error) => {
        console.log(error.message);
    }

timeout

    timeout: 60000; /* 1-minute request timeout */