Nocturnal Pumpkin Maelstrom

    notification-store

    0.0.11 • Public • Published

    Travis (.com) Coverals github npm

    notification-store

    A topic-based pub-sub notification store with timer support. A notification store will keep all messages that have been published but not acknowledged, and a topic-based, pub-sub system decouples senders and receivers with topics (paths). Instead of receiving a single message on notification, the subscribers will receive all messages in the store when being notified.

    The uniqueness of this library lies in that we manage to separate the data structure of messages and subscribers. This way, developers can design their storing mechanism and integrate this library into the codebase.

    Installation

    This package is available on npm:

    $ npm install --save notification-store

    Then, we recommend use it with a module bundler like Webpack

    import NotificationStore from 'notification-store'
     
    // If you want to roll your own store
    import createSubscriberStore from 'notification-store/subscriber'
    import createStore from 'notification-store/store'
    import connect from 'notification-store/core'

    Alternatively, this package is available on unpkg:

    <script src="https://unpkg.com/notification-store@latest/umd/index.min.js"></script>
     
    <!-- again, these are optional components -->
    <script src="https://unpkg.com/notification-store@latest/umd/subscriber.min.js"></script>
    <script src="https://unpkg.com/notification-store@latest/umd/store.min.js"></script>
    <script src="https://unpkg.com/notification-store@latest/umd/core.min.js"></script>

    and can be used as

    new NotificationStore()
     
    // and
    NotificationStore.createSubscriberStore()
    NotificationStore.createStore()
    NotificationStore.connect()

    Note that this package can also be used in Node.js, but you have to append .default after the require() function.

    Quick Start

    The main script expose a single class with member functions manipulating the store. A minimal example looks like this:

    const { notify, subscribe } = new NotificationStore()
     
    const button = document.querySelector('#button')
     
    button.addEventListener('click', () => {
      notify('count', {}, 3000)
    })
     
    subscribe(arr => (button.innerText = arr.length), 'count')

    See the Examples section.

    APIs

    • subscribe(func, [...paths]): when notified on any of the paths (and their subdomains), func will be called.

      • func(arr): arr is a list of data (in insertion order) under a path being notified.
      • paths: if omitted, the function will subscribe to all paths (so it will be notified for all paths.)
    • unsubscribe(func): unsubscribe the function.

    • unsubscribeByPath(path): remove all subscribers under path.

    • notify(path, payload, callback = null, duration = -1): notify on path with payload. Return a key so you can acknowledge it (see below). The content/pattern of the key is an implementation detail.

      • path: a string indicating what will be notified.
      • payload: an object. Notice that this parameter is required.
      • callback(path, payload): optional. If provided, it will be called when the payload is removed from the store.
      • duration: optional. If it is bigger than zero, it will be automatically removed in duration (ms).
    • acknowledge(key): Remove the payload from the store. If it is already removed, calling this function won't cause error.

    Internal APIs

    You can skip this section if your messages and subscription list are stored in the notification-store. If that is not what you want, the following three sections introduce the internal APIs that can help you integrate your customization into notification-store

    createSubscriberStore() from 'notification-store/subscriber'

    This function will return an object

    {
      getClients,
      subscribe,
      unsubscribe,
      unsubscribeByPath,
    }

    If you want to customize the way subscription list are stored, you have to implement your version of this function.

    • getClients(path = '*'): return a set of functions subscribing to this path.
      • path: if omitted, all functions will be returned.
    • subscribe: see above.
    • unsubscribe: see above.
    • unsubscribeByPath: see above.

    createStore() from 'notification-store/store'

    This function will return an object

    {
      publish,
      cancel,
    }

    If you want to customize the way messages are stored or optimize how data are sended to the subscribers, you have to implement your version of this function.

    • publish(data, funcs): this function adds data to the store and calls all funcs with an array of payloads that have been in the store.

      • data: an object with shape { key, callback, duration, payload }
      • funcs: a iterable containing all functions that will be notified.
    • cancel(data, funcs): this function removes data from the store and calls all funcs with an array of payloads that have been in the store.

      • data: an object with shape { key, callback, duration, payload }
      • funcs: a iterable containing all functions that will be notified.

    connect from 'notification-store/core'

    This function connects subscribers and store together and returns { notify, acknowledge }. You don't have to worry about this function, just use it to get notify and acknowledge function.

    • connect({ getClients, publish, cancel })

    Integration with Redux

    Redux manages a global state and can only be updated by dispatching an action. Therefore, to integrate this library with Redux, we have two options:

    1. Write a function that subscribes to the notification store. Inside the function, dispatch an action to update the Redux store. This methods will have duplicated message arrays in Redux and in this library, but you don't have to fight with internal APIs of notification store.
    2. Write your own publish and cancel functions which dispatch actions to add/remove data from Redux store. Then, similar to lib/index.js, connect getClients (from notification-store/subscribers), publish, and cancel, get notify and acknowledge function and expose them. Note that other reducers shouldn't modify this part of Redux store, otherwise subscribers won't be immediately notified. See Examples.

    Examples

    TODO

    • Add Promise as a subscriber.

    License

    MIT

    Install

    npm i notification-store

    DownloadsWeekly Downloads

    0

    Version

    0.0.11

    License

    MIT

    Unpacked Size

    49.3 kB

    Total Files

    19

    Last publish

    Collaborators

    • patrickchen