pairs-js v1.0.1

js-pairs

Install

npm install pairs-js

Using

import { cons, car, cdr, toString } from 'pairs-js';

const pair = cons(1, 2);
car(pair); // 1
cdr(pair); // 2
toString(pair); // (1, 2)

const pair2 = cons(1, cons(2, 3));
car(pair); //1
cdr(pair); //pair(2, 3);
toString(pair2); //(1, (2, 3);

Documentation

Table of Contents

• cons
  • Parameters
  • Examples
• isPair
  • Parameters
  • Examples
• car
  • Parameters
  • Examples
• cdr
  • Parameters
  • Examples
• toString
  • Parameters
  • Examples

cons

Make a pair

Parameters

• a any
• b any

Examples

const pair = cons(1, 'text');

const pair = cons(1, cons(3, 4));

Returns function (any): any

isPair

Check if it a Pair

Parameters

• pair

Examples

const pair1 = cons (1, 2);
isPair(pair1); // true

const somethingElse = 'iAmText';
isPair(somethingElse); // false

Returns boolean

car

Get first element from pair

Parameters

• pair

Examples

const pair = cons(1, 2);
car(pair); //1

Returns any first Element

cdr

Get second element from pair

Parameters

• pair

Examples

const pair = cons(1, 2);
cdr(pair); //2

Returns any second element

toString

Convert pair to string

Parameters

• pair

Examples

const pair1 = cons(1, 2);
toString(pair1); // (1, 2)

const pair2 = cons(1, cons(1, 2));
toString(pair2); // (1, (1, 2));

Returns any string