Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
an OOP javascript library for node.js and the browsers
JavaScript
branch: cc-add-further…

This branch is 108 commits behind kamicane:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
doc
es5
shell
test
.gitignore
.jshintrc
.npmignore
.travis.yml
Makefile
README.md
emitter.js
index.js
map.js
package.json
shell.js
type.js

README.md

prime |prīm|

  1. fundamental, basic, essential.
  2. make (something) ready for use or action.
  3. archetypal, prototypical, typical, classic.

Description

prime is an Object Oriented JavaScript library. It helps you with prototypal inheritance and contains generic utilities for every-day JavaScripting.

No Native JavaScript Objects were harmed in the making of this library.

Modules Overview

A short overview of the available modules. For more information, refer to the documentation.

prime

The function to create new primes.

var prime = require("prime")

var Animal = prime({
    say: function(){
        return "!!"
    }
})

var Cat = prime({
    inherits: Animal,
    say: function(){
        return "meaow" + Cat.parent.say.call(this)
    }
})

prime/shell

The base shell. As you require more shells, the base shell will be augmented. Requiring specific shells gives you access to generic methods as well.

var array = require("prime/shell/array")

array.indexOf([1,2,3], 3) // 3

var _ = require("prime/shell")

_([1,2,3]).remove(1).each(function(number){
    console.log(number)
})

prime/emitter

The event emitter.

var Emitter = require("prime/emitter")

var Dog = prime({
    inherits: Animal,
    say: function(){
        var word = "wuff" + Dog.parent.say.call(this)
        this.emit("say", word)
        return word
    }
})

Dog.implement(new Emitter)

var barkley = new Dog

barkley.on("say", function(word){
    console.log("barkley barked", word)
})

prime/map

Simple WeakMap implementation.

var Map = require("prime/map")

var map = new Map()

map.set(domElement, "header")
map.set(domElement2, "footer")
map.get(domElement) // "header"
map.get(domElement2) // "footer"

prime/type

Type checker.

var type = require("prime/type")

type("string") // "string"
type([]) // "array"
type(function(){}) // "function"
type(/regexp/) // "regexp"
type(new Date) // "date"
type(10) // "number"
type(false) // "boolean"
type({}) // "object"
type(arguments) // "object"

type(null) // "null"
type(undefined) // "null"
type(NaN) // "null"

prime/shell/array

Array methods.

require("prime/shell/array")

prime/shell/object

Object methods.

require("prime/shell/object")

prime/shell/string

String methods.

require("prime/shell/string")

prime/shell/number

Number methods.

require("prime/shell/number")

prime/shell/function

Function methods.

require("prime/shell/function")

prime/shell/regexp

Regexp methods.

require("prime/shell/regexp")

prime/shell/date

Date methods.

require("prime/shell/date")

Build Status

Something went wrong with that request. Please try again.