mirror of
https://github.com/shimataro/ssh-key-action.git
synced 2025-06-19 22:52:10 +10:00
* first action! (#1)
This commit is contained in:
parent
8deacc95b1
commit
ace1e6a69a
3750 changed files with 1155519 additions and 0 deletions
280
node_modules/cint/README.md
generated
vendored
Normal file
280
node_modules/cint/README.md
generated
vendored
Normal file
|
@ -0,0 +1,280 @@
|
|||
A Javascript utility belt with an emphasis on Functional Programming.
|
||||
|
||||
[](http://badge.fury.io/js/cint) [<img src="https://travis-ci.org/metaraine/cint.svg">](https://travis-ci.org/metaraine/cint)
|
||||
|
||||
# Usage
|
||||
|
||||
Read the API (below) or check out some examples used in the [unit tests](https://github.com/metaraine/cint/blob/master/test/index.html).
|
||||
|
||||
# Installation
|
||||
|
||||
## Client-Side
|
||||
|
||||
Bower:
|
||||
|
||||
bower install cint --save
|
||||
|
||||
Include it:
|
||||
|
||||
<script src="bower_components/cint/cint.min.js"></script>
|
||||
|
||||
## Server-Side
|
||||
|
||||
Install it:
|
||||
|
||||
npm install cint --save
|
||||
|
||||
Require it:
|
||||
|
||||
var cint = require("cint");
|
||||
|
||||
# Unit Tests
|
||||
|
||||
npm test
|
||||
|
||||
# API
|
||||
|
||||
## Function
|
||||
|
||||
/** Returns a function that returns the inverse of the given boolean function. */
|
||||
cint.not(f)
|
||||
|
||||
/** Returns a new function that inserts the given curried arguments to the inner function at the specified index of its runtime arguments.
|
||||
i.e. _.partial(f, args...) is equivalent to cint.partialAt(f, 0, args) and _.partialRight(f, args...) is equivalent to cint.partialAt(f, n, args) where n is the arity of the function.
|
||||
*/
|
||||
cint.partialAt(f, index, curriedArgs)
|
||||
|
||||
/** Returns a new function that calls the given function with a limit on the number of arguments. */
|
||||
cint.aritize(f, n)
|
||||
|
||||
/** Recursively invokes the given function with no parameters until it returns a non-functional value. */
|
||||
cint.callTillValue(value)
|
||||
|
||||
/** Calls the given function as normal, then passes its inputs and output to the spier (defaults to console.log) */
|
||||
cint.spy(f, spier)
|
||||
|
||||
/** Returns a copy of the given function that calls the original function in the context of the first argument. Passes arguments 1..n as normal. */
|
||||
cint.inContext(f)
|
||||
|
||||
/** Converts the given synchronous function into an asynchronous function that applies its arguments to the original function and invokes callback(error, result) */
|
||||
cint.toAsync(f)
|
||||
|
||||
## String
|
||||
|
||||
/** Performs variable substitution on the string, replacing items in {curly braces}.
|
||||
Based on supplant by Douglas Crockford http://javascript.crockford.com/remedial.html
|
||||
*/
|
||||
cint.supplant(str, o)
|
||||
|
||||
/** Returns true if the string starts with the given substring. */
|
||||
cint.startsWith(str, sub)
|
||||
|
||||
/** Returns the substring before the first instance of the given delimiter. */
|
||||
cint.before(str, delim)
|
||||
|
||||
/** Returns the substring after the first instance of the given delimiter. Returns the whole string if the delimiter is not found. */
|
||||
cint.after(str, delim)
|
||||
|
||||
/** Returns the substring between the given delimiters. */
|
||||
cint.betweenstr, left, right)
|
||||
|
||||
/** Wraps a string with a left and right */
|
||||
cint.bookend(middle, left, right)
|
||||
|
||||
/** Returns a single string that repeats the string n times. */
|
||||
cint.repeatString(str, n, delim)
|
||||
|
||||
/** Capitalizes the first letter of each word in the given string. */
|
||||
cint.toTitleCase(str)
|
||||
|
||||
## Number
|
||||
|
||||
/** Returns the ordinal value (like '1st' or '2nd') of the given integer. */
|
||||
cint.ordinal(n)
|
||||
|
||||
/** Invokes the given function n times, passing the index for each invocation, and returns an array of the results. */
|
||||
cint.mapNumber(n, f)
|
||||
|
||||
## Array
|
||||
|
||||
/** Returns a list of values plucked from the property from the given array. If the values are functions, they wll be bound to the array item. */
|
||||
cint.pluck(arr, property)
|
||||
|
||||
/** Group the array of objects by one of the object's properties or mappable function. Returns a dictionary containing the original array's items indexed by the property value. */
|
||||
cint.group(arr, propOrFunc)
|
||||
|
||||
/** Group the array of objects by one of the object's properties or mappable function. Returns an array of { key: ___, items: ___ } objects which represent all the items in the original array grouped by the value of the specified grouping key. */
|
||||
cint.orderedGroup(arr, propOrFunc)
|
||||
|
||||
/** Returns a dictionary whose keys are the values of the array and values are the number of instances of that value within the array. */
|
||||
cint.tally(arr)
|
||||
|
||||
/** Tally the property values of an array of object, grouping the counts for each property under its value.
|
||||
e.g.
|
||||
[
|
||||
{
|
||||
ideal: 4,
|
||||
past: 3,
|
||||
present: 7
|
||||
},
|
||||
{
|
||||
ideal: 5,
|
||||
past: 7,
|
||||
present: 7
|
||||
}
|
||||
]
|
||||
|
||||
=>
|
||||
|
||||
{
|
||||
"4": {
|
||||
ideal: 1
|
||||
},
|
||||
"3": {
|
||||
past: 1
|
||||
}
|
||||
"5": {
|
||||
ideal: 1
|
||||
}
|
||||
"7": {
|
||||
present: 2,
|
||||
past: 1
|
||||
}
|
||||
}
|
||||
*/
|
||||
cint.tallyProps(arr)
|
||||
|
||||
/** Returns the unique values in the array. */
|
||||
cint.unique(arr)
|
||||
|
||||
/** Returns the reverse of the given array. Unlike the native reverse, does not modify the original array. */
|
||||
cint.reversed(arr)
|
||||
|
||||
/** Indexes into an array, supports negative indices. */
|
||||
cint.index(arr, i)
|
||||
|
||||
/** Returns a new array containing the elements of the given array shifted n spaces to the left, wrapping around the end. */
|
||||
cint.rotate(arr, n)
|
||||
|
||||
/** Creates an object with a property for each element of the given array, determined by a function that returns the property as a { key: value }. */
|
||||
cint.toObject(arr, f)
|
||||
|
||||
/** Returns the first item in the given array that returns true for the given function. If no item is found, returns null. */
|
||||
cint.find(arr, f)
|
||||
|
||||
/** Returns the first item in the given array whose specified property matches the given value. */
|
||||
cint.findByProperty(arr, prop, value)
|
||||
|
||||
/** Functional, nondestructive version of Array.prototype.splice. */
|
||||
cint.spliced(arr, index, howMany/*, elements*/
|
||||
|
||||
/** Returns an array of sequential integers from start to end (inclusive). If only one parameter is specified, start is 1. */
|
||||
cint.range(start, end)
|
||||
|
||||
/** Returns a new array that only includes items with a specific value of a given property. */
|
||||
cint.filterBy(arr, prop, value)
|
||||
|
||||
/** Breaks up the array into n evenly-sized chunks.
|
||||
Solution from http://stackoverflow.com/questions/8188548/splitting-a-js-array-into-n-arrays
|
||||
*/
|
||||
cint.chunk(a, n)
|
||||
|
||||
## Object
|
||||
|
||||
/** Returns an array of the object's values. */
|
||||
cint.values(o)
|
||||
|
||||
/** Returns a new object with the given key and value. */
|
||||
cint.keyValue(key, value)
|
||||
|
||||
/** Gets the value of a key of the given object. */
|
||||
cint.getValue(o, key)
|
||||
|
||||
/** Sets the value of the given key and returns the object. */
|
||||
cint.setValue(o, key, value)
|
||||
|
||||
/** Creates a mapping function that applies the given function to the value of the specified key. */
|
||||
cint.mapOverKey(f, originalKey, newKey)
|
||||
|
||||
/** Join the object into a single string with the given separators separating properties from each other as well as values. */
|
||||
cint.joinObject(obj, propSeparator, valueSeparator)
|
||||
|
||||
/** Returns true if the object has no non-undefined properties.
|
||||
@author Douglas Crockford http://javascript.crockford.com/remedial.html
|
||||
*/
|
||||
cint.isEmpty(o)
|
||||
|
||||
/** Returns the number of properties on the given object. */
|
||||
cint.numProperties(o)
|
||||
|
||||
/** Returns a new object with the given objects merged onto it. Non-undefined properties on later arguments override identical properties on earlier arguments. */
|
||||
cint.merge(/*obj1, obj2, obj3, ...*/)
|
||||
|
||||
/** Returns a new object where f(key, value) returns a new key-value pair for each property. */
|
||||
cint.mapObject(obj, f)
|
||||
|
||||
/** Returns an array whose items are the result of calling f(key, value) on each property of the given object. If f is undefined, returns a list of { key: ___, value: ___ } objects. */
|
||||
cint.toArray(obj, f)
|
||||
|
||||
/** Returns a new object that only includes the properties of the given obj for which f(key, value) is true. */
|
||||
cint.filterObject(obj, f)
|
||||
|
||||
/** Changes the specified keys in an object.
|
||||
@example cint.changeKeys(
|
||||
{ fname: 'Raine', lname: 'Lourie', specialty: 'Javascript' },
|
||||
{ fname: 'first', lname: 'last' }
|
||||
)
|
||||
*/
|
||||
cint.changeKeys(obj, changedKeys)
|
||||
|
||||
/** Calls a function on an object and returns the object (for chaining purposes). */
|
||||
cint.tap(f, o)
|
||||
|
||||
/* console.log's the given object and returns the object (for chaining purposes). */
|
||||
cint.look(o)
|
||||
|
||||
## Utility
|
||||
|
||||
/** Adds two numbers. */
|
||||
cint.addTwo(x, y)
|
||||
|
||||
/** Adds all given arguments. */
|
||||
cint.add(/*x,y,z,...*/)
|
||||
|
||||
/** Compares two items lexigraphically. Returns 1 if a>b, 0 if a==b, or -1 if a<b. */
|
||||
cint.compare(a,b)
|
||||
|
||||
/** Returns a function that compares the given property of two items. */
|
||||
cint.compareProperty(property)
|
||||
|
||||
/** Returns a compare function that can be passed to Array.sort to sort in the order of the given array of properties. A property can also be appended with ' ASC' or ' DESC' to control the sort order.
|
||||
*/
|
||||
cint.dynamicCompare(props)
|
||||
|
||||
/** Returns true if all the items in a are equal to all the items in b, recursively. */
|
||||
cint.equals(a,b)
|
||||
|
||||
/** in operator as a function. */
|
||||
cint.hasKey(creamFilling, donut)
|
||||
|
||||
/** Returns true if the given value is not undefined, null, or an empty string. */
|
||||
cint.hasValue(x)
|
||||
|
||||
/** Returns a string representation of the given scalar, array, or dictionary. */
|
||||
cint.hash(o)
|
||||
|
||||
/** Generates a pseudo-random string that can be assumed to be unique.
|
||||
@remarks untestable
|
||||
*/
|
||||
cint.guid()
|
||||
|
||||
/** Returns a string representing the type of the object, with special handling for null and arrays.
|
||||
@author Douglas Crockford http://javascript.crockford.com/remedial.html
|
||||
*/
|
||||
cint.typeOf(value)
|
||||
|
||||
/** Create a new instance of the given constructor with the given constructor arguments. Useful for higher order programmer where the new keyword won't work. */
|
||||
cint.createNew(C, args)
|
||||
|
||||
/** Converts the given value to a string by calling its toString method. */
|
||||
cint.intoString(value)
|
Loading…
Add table
Add a link
Reference in a new issue