Pickpocket.js

Simplification at its finest

• Zero Non Dev Dependencies
• Syntactically Pleasing
• Extremely Lightweight
• Simply Enjoyable
• Minimalistic
• Simplified
• Tested

Installation

NPM

1npm install --save-dev pickpocket.js

Yarn

1yarn add pickpocket.js --save

Pick Pocket Api

Simplified Wrapper Around Common Data Structure

• any()
• all()
• list()
• set(data)
• forget()
• has(field)
• get(field)
• list(field)
• add(field, item)
• set(field, item)
• forget(field)

Any

Determine if there are "any" items in pocket

1const pocket = pickpocket({
2	name: ['name is a required', 'name must be a string'],
3	email: ['email is a required field', 'email must be an email']
4});
5
6
7pocket.any();

true

All

Retrieve all data within pocket

1const pocket = pickpocket({
2	name: ['name is a required', 'name must be a string'],
3	email: ['email is a required field', 'email must be an email']
4});
5
6
7pocket.all();

{
	name: ['name is a required', 'name must be a string'],
	email: ['email is a required field', 'email must be an email']
}

1let data = { name: '', email: '' };
2let rules = { name: 'required', email: 'email|required' };
3let validation = validator(data, rules).validate();
4
5validation.errors().all();

List

Flat list of all pocket field items

1const pocket = pickpocket({
2	name: ['name is a required', 'name must be a string'],
3	email: ['email is a required field', 'email must be an email']
4});
5
6
7pocket.list();

[
	'name is a required', 
	'name must be a string', 
	'email must be an email',
	'email is a required field', 	
]

Set

Set entirety of pocket data

1const pocket = pickpocket({
2	name: ['name is a required', 'name must be a string'],
3	email: ['email is a required field', 'email must be an email']
4});
5
6pocket.set({
7	name: ['eyy'],
8	something: ['ohh']
9});

Forget

Forget all pocket data

1const pocket = pickpocket({
2	name: ['name is a required', 'name must be a string'],
3	email: ['email is a required field', 'email must be an email']
4});
5
6pocket.forget();
7pocket.all(); // {}

Has

Determine if specified field "has" items

1const pocket = pickpocket({
2	tag: [],
3	name: [],
4	email: ['email is a required', 'email must be an email'],
5});
6
7
8pocket.has('tag'); // false
9pocket.has('name'); // false
10pocket.has('email'); // true
11pocket.has('something_else'); // false

Get

Get _first_ item from specific field

1const pocket = pickpocket({
2	tag: [],
3	name: [],
4	email: ['email is a required', 'email must be an email'],
5});
6pocket.get('email');

List Field

List items for specific field

1const pocket = pickpocket({
2	tag: [],
3	name: [],
4	email: ['email is a required', 'email must be an email'],
5});
6pocket.list('email');

['email is a required', 'email must be an email']

Add

Add item to specific field

1const pocket = pickpocket({
2	tag: [],
3	name: [],
4	email: ['email is a required', 'email must be an email'],
5});
6
7pocket.add('tag', 'simplified');
8pocket.list('tag'); // ['simplified'];
9
10pocket.add('email', 'extrafied');
11pocket.list('email'); // ['email is a required', 'email must be an email', 'extrafied']

Set Field

Set specified field items

1const pocket = pickpocket({
2	tag: [],
3	name: [],
4	email: ['email is a required', 'email must be an email'],
5});
6
7pocket.set('email', ['set', 'email', 'items', 'list']);
8
9pocket.list('email');

['set', 'email', 'items', 'list']

Forget Field

Forget items on the specified field

1const pocket = pickpocket({
2	tag: [],
3	name: [],
4	email: ['email is a required', 'email must be an email'],
5});
6
7pocket.forget('email');
8
9pocket.list('email');

[]

Utilization

Pickpocket.js (Simplified)

Example One: Form Error Messages (Organized Per Field)

Common Example

1
2const pickpocket = require('pickpocket.js');
3
4const errors = pickpocket({
5	name: ['name is required', 'name is not a string', 'name needs to be cool'],
6	email: ['email field must be an email']
7});
8
9// errors.all()
10// errors.list()
11// errors.any()
12// errors.add('name', 'message')
13// errors.list('email')
14// errors.has(field)
15// errors.set({})
16// errors.set('email', [])
17// errors.forget()
18// errors.forget('email')
19// etc...

Example Two: Human Life Cycle (Organized By Life Moments: Life Moments Have Callback Functions)

Advanced example

1
2const pickpocket = require('pickpocket.js');
3
4const life = pickpocket({
5	before: [
6		firstBeforeMomentCallback, 
7		secondBeforeMomentCallback, 
8		thirdBeforeMomentCallback
9	],
10	passed: [
11		firstPassedMomentCallback, 
12		secondPassedMomentCallback
13	],
14	failed: [
15		firstFailedMomentCallback
16	],
17	after: [
18		firstAfterMomentCallback, 
19		secondAfterMomentCallback
20	],
21});
22
23life.eventful = (human = {}, moment) => {
24	if (life.has(moment)) {
25		this.list(moment).forEach(event => event(human));
26
27		life.forget(moment);
28	}
29
30};
31
32const moments = ['before', 'during', 'failed', 'passed', 'after'];
33
34/**
35 * Add during life moment
36 */
37life.set('during', [
38	person => console.log(`${person.name} is going to kindergarden`),
39	person => console.log(`${person.name} was held back in kindergarden`),
40	person => { 
41		person.age++;
42
43		console.log(`${person.name} had there birthday today`)
44	},
45	person => console.log(`${person.name} is ${person.age} and still in kindergarden`),
46	person => console.log(`${person.name} is going to have one heck of a time during life`),
47	// etc...
48]);
49
50
51let human = { age: 0, name: 'zak', birthed: 'April 22 1997' };
52moments.forEach(moment => life.eventful(human, moment))
53
54
55### Contribute
56
57PRs are welcomed to this project.
58If you want to improve the pickpocket.js library, add
59functionality or improve the docs please feel free to submit a PR.
60
61
62### License
63
64MIT © [Zachary Horton ~ (Clean Code Studio)](https://github.com/zhorton34/pickpocket.js)