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

digger-contracts

v2.0.0

Published

The contract factory for digger server requests

Downloads

19

Readme

digger-contracts

Build status

The contract factory for digger server requests

installation

$ npm install digger-contracts

usage

There are four types of contract that digger can resolve:

  • select - load data from below a container using a selector filter
  • append - add containers to another container
  • save - update the data for a container
  • remove - remove a container

select example

Generate a select contract from a container by running the container as a function or running the 'select' method.

You give the selector and context as arguments - the context is piped into the selector.

var container = $digger.connect('/my/location');
var contract = container('folder.red', '#top');

console.log(contract.parse());

/*
{
	method:'post',
	url:'/select',
	headers:{
		'x-digger-selector':'folder.red',
		'x-digger-context':'#top'
	}
	body:[
		'/my/location'
	]
}	
*/

append example

Generate an append contract by appending a container to another container:

var container = $digger.connect('/my/location');

var child = $digger.create('folder', {
	name:'test'
})

var contract = container.append(child);

console.log(contract.parse());


/*

	{
		method:'post',
		url:'/my/location',
		body:[{
			name:'test',
			_digger:{
				tag:'folder',
				diggerid:3249394383838,
				path:'/my/location',
				inode:'df9f83'
			}
		}]
	}
	
*/

save example

Generate a save contract by calling the save method on a container:

var warehouse = $digger.connect('/my/location');

warehouse('folder.red').ship(function(folder){
	var contract = folder.attr('price', 34).save();

	console.log(contract.parse());
})

/*

	{
		method:'put',
		url:'/data/my/location/343fc3/33f33f',
		body:{
			name:'item',
			price:34,
			_digger:{
				path:'/my/location/343fc3/33f33f',
				tag:'folder',
				class:['red']
			}
		}
	}
	
*/

remove example

Generate a remove contract:

var warehouse = $digger.connect('/my/location');

warehouse('folder.red').ship(function(folder){
	var contract = folder.remove();

	console.log(contract.parse());
})

/*

	{
		method:'delete',
		url:'/data/my/location/343fc3/33f33f'
	}
	
*/