Coder Social home page Coder Social logo

likedb's Introduction

likedb

Kozmos' client-side database for keeping bookmarks offline in the browser using indexeddb. It syncs with Kozmos servers when user is online.

Install

$ yarn add kozmos/likedb

Usage

Initialize using your personal API key & secret:

import likedb from 'likedb'

const db = likedb({
  apiKey: '',
  apiSecret: '',
  host: '',
  postIntervalSecs: 1.5, // Post updates -if there are any- every 1.5 seconds
  pushIntervalSecs: 60, // Check for updates every 60 seconds
  onPostUpdates: () => console.info('Kozmos just posted some updates to server'),
  onReceiveUpdates: () => console.info('Kozmos just received some updates from server')
  onError: (error, action) => console.info('Failed during %s: %s', error.action, error)
})

Add a page to likes:

db.likes.like('github.com', err => console.error(err))

Delete a page from your likes:

db.likes.unlike('github.com', err => console.error(err))

Check if a page is liked:

db.likes.get('github.com', (error, doc) => {
  error
  // => undefined

  doc
  // => undefined
})

Relation with Kaktüs

This library is based on Kaktüs Web Browser's database library. Although it only stores bookmarks, in the future kaktüs' meta store and its builtin keyword search will be useful for implementing offline search.

likedb's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.