❤
npm
Sign UpSign In

object-cursor-stream

1.1.0 • Public • Published

object-cursor-stream

de-duped keypath stream

Build Status npm install

Example

var cursorStream = require('object-cursor-stream')
 
var cursor = cursorStream('pokemon.name')
 
cursor.write({pokemon: {type: 'chansey', name: 'Dr. Chansey'}}) // 'Dr. Chansey'
cursor.write({pokemon: {type: 'pikachu', name: 'Dr. Chansey'}}) // *nothing emitted*
cursor.write({pokemon: {type: 'pikachu', name: 'Prof. Oak'}}) // 'Prof. Oak'
cursor.write({pokemon: {type: 'pikachu'}}) // undefined
 
var cursor2 = cursorStream('pokemon.name', 'Spike')
 
cursor2.write({pokemon: {type: 'chansey', name: 'Dr. Chansey'}}) // 'Dr. Chansey'
cursor2.write({pokemon: {type: 'pikachu', name: 'Dr. Chansey'}}) // *nothing emitted*
cursor2.write({pokemon: {type: 'pikachu', name: 'Prof. Oak'}}) // 'Prof. Oak'
cursor2.write({pokemon: {type: 'pikachu'}}) // 'Spike'

API

cursorStream(keypath[, fallback]) -> DuplexStream

  • keypath is a string representing a path to the data you want from the written data.
  • fallback is an optional argument that will be emitted if the data at keypath is undefined.

License

This project is licensed under the Apache License, Version 2.0. See LICENSE for the full license.

/object-cursor-stream/

    Package Sidebar

    Install

    npm i object-cursor-stream

    Repository

    github.com/urbanairship/object-cursor-stream

    Homepage

    github.com/urbanairship/object-cursor-stream#readme

    Weekly Downloads

    3

    Version

    1.1.0

    License

    Apache-2.0

    Last publish

    Collaborators

    • urbanairship
    Try on RunKit
    Report malware