Documentation Home Github Functions in Bijou

Global

Members

Object

# _temp

Bijou.js source documentation. In the Bijou namespace you will find the documentation for all of the functions in Bijou.js, if you have any questions, suggestions or bug reports pleast make an issue (here)[https://github.com/bijou-js/bijou.js/issues/new/choose]. Best of luck! Thanks for using Bijou.js! --Explosion--

Author:
  • Explosion-Scratch, GrahamSH-LLK, Bijou.js contributors

View Source _end.js, line 160

# prototype

Converts most of the functions of Bijou.js to prototype functions. Note that you have to call this function to add the prototypes.

View Source _end.js, line 8

Methods

# node()

Tests if the user is using Node.js or not and throws an error in specific functions (that require the DOM) if they are.

View Source _copyright.js, line 87

Type Definitions

# animateCallback(num, percent) → {undefined}

Parameters:
Name Type Description
num Number
percent Number

View Source math.js, line 135

undefined

# animateNumCallback(num) → {Number}

Parameters:
Name Type Description
num Number

View Source math.js, line 130

Number

# averageByFn(number) → {Number}

Parameters:
Name Type Description
number Number

The number to perform the operation on

View Source array.js, line 262

The number to average

Number

# eachCallback(x, i, array)

Parameters:
Name Type Description
x any

The item of the array/string/number range
i Number

The index of the item in the array/string/number range
array Array.<any>

The original array

View Source array.js, line 298

# eventListenersCallback(e) → {undefined}

Parameters:
Name Type Description
e Event

The event object

View Source element.js, line 731

undefined

# juxtCallback(…args) → {Array.<array>}

Parameters:
Name Type Attributes Description
args any <repeatable>

The arguments to run on the functions

View Source function.js, line 2

The list of outputs.

Array.<array>

# listenCallback(key, value) → {undefined}

Parameters:
Name Type Description
key String | Symbol

The key being accessed
value any

The value of the key being accessed

View Source object.js, line 118

undefined

# manipulateVideoStreamFunction(pixel) → {Object}

Parameters:
Name Type Description
pixel Object
red Number

The red value of the pixel (0-255)
green Number

The green value of the pixel (0-255)
blue Number

The blue value of the pixel (0-255)
alpha Number

The alpha value of the pixel (0-255)

View Source utility.js, line 31

Returns an object with red, green, blue and alpha keys.

Object
Example
//Example function given to _$.manipulate
(color) => {
	if (color.green > 200){
		//Simple greenscreen effect
		color.alpha = 0;
	}
	return color;
}

# mapCallback(item, i, arr)

Parameters:
Name Type Description
item any

The item
i Number

The index of the item
arr Array

The original array

View Source string.js, line 206

# mapObjKeysCallback(key) → {String}

Parameters:
Name Type Description
key String

The key

View Source object.js, line 184

String

# mapObjValuesCallback(value) → {any}

Parameters:
Name Type Description
value any

The value

View Source object.js, line 217

any

# replaceTextCallback(text) → {String}

Parameters:
Name Type Description
text String

The text to replace

View Source element.js, line 463

The replaced text

String

# scrollStopCallback(event) → {undefined}

Parameters:
Name Type Description
event UIEvent

The event object

View Source event.js, line 61

undefined

# sortTableCallback(td, tr, cellIndex) → {String}

Parameters:
Name Type Description
td HTMLTableCellElement

The td element
tr HTMLTableRowElement

The tr element
cellIndex Number

The cell index

View Source element.js, line 781

The cell content

String

# spreadCallback(args) → {any}

Parameters:
Name Type Description
args Array

The array of arguments

View Source function.js, line 79

any