npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

cycni

v2.1.0

Published

A collection manipulation tool

Downloads

4

Readme

Cycni

A collection manipulation tool

Overview

Cycni enables the ability to manipulation and interact with an infinitely deep collection. It provides an interface to manipulate Objects and Arrays in a seamless and consistent method. Now using async/await.

Install

  • npm i cycni --save
  • UMD dist/cycni.js
  • ESMD src/cycni.js

Examples

let data = 	{
	id: '0',
	name: 'Cake',
	batters: [
		{ id: 'zero', type: 'Regular' },
		{ id: 'one', type: 'Chocolate' },
		{ id: 'two', type: 'Blueberry' }
	]
};

let res, opt = {
	data: data,
	keys: ['batters', 0]
};

try {
	res = await Cycni.remove(opt);
} catch (e) {
	console.error(e);
}

console.log(data); /*
	{
		id: '0',
		name: 'Cake',
		batters: [
			{ id: 'one', type: 'Chocolate' },
			{ id: 'two', type: 'Blueberry' }
		]
  	}
*/

console.log(res); /*
	{ id: 'zero', type: 'Regular' }
*/

Api

Cycni.get(opt)

Returns the retrieved value.

  • opt: Object
    • value: Any
    • keys: Array
    • data: Object, Array

Cycni.set(opt)

If a key does not exists and the key is a String then an Object is created. If a key does not exists and the key is a Number then an Array is created. If the key already exists it overwrites that value.

  • opt: Object
    • value: Any
    • keys: Array
    • data: Object, Array

Cycni.add(opt)

If a key in the keys does not exist or if you try to set a key that already exists this will throw an error.

  • opt: Object
    • value: Any
    • keys: Array
    • data: Object, Array

Cycni.push(opt)

Dynamically pushes data to an Array or Object. If pushing to an Object then a key will auto generate in the form of _N N being the length.

  • opt: Object
    • value: Any
    • keys: Array
      • ['.'] top level reference
    • data: Object, Array

Cycni.remove(opt)

Returns any removed data.

  • opt: Object
  • value: Any
    • keys: Array
    • data: Object, Array

Cycni.has(opt)

Returns true or false.

  • opt: Object
    • value: Any
    • keys: Array
    • data: Object, Array

Cycni.size(opt)

Returns the length of the Array or the length of the Keys if it is an object.

  • opt: Object
    • value: Any
    • keys: Array
      • ['.'] top level reference
    • data: Object, Array

Cycni.traverse(opt)

Returns an Object with two properties. The last key in the keys array res.key. The parent of the last key in the keys array res.data.

  • opt: Object
    • value: Any
    • keys: Array
    • data: Object, Array

Cycni.clone(Any)

Returns a clone.

Authors

AlexanderElias

License

Why You Should Choose MPL-2.0 This project is licensed under the MPL-2.0 License