Returns a new instance of this Record type with all values set to their default values.
Returns a new instance of this Record type with the value for the specific key set to its default value.
Returns the value associated with the provided key, which may be the default value defined when creating the Record factory function.
If the requested key is not defined by this Record type, then notSetValue will be returned if provided. Note that this scenario would produce an error when using Flow or TypeScript.
Value of alpha channel [0-255]
Value of blue channel [0-255]
Value of green channel [0-255]
Compute a highlighted version of this Color.
New Color object
Value of red channel [0-255]
Creates a new color that is equal to this but with a certain alpha value
Value of alpha channel [0-255]
New Color object
Creates a new color that is equal to this but with a certain blue value
Value of blue channel [0-255]
New Color object
Creates a new color that is equal to this but with a certain green value
Value of green channel [0-255]
New Color object
Creates a new color that is equal to this but with a certain red value
Value of red channel [0-255]
New Color object
Deeply converts this Record to equivalent native JavaScript Object.
Note: This method may not be overridden. Objects with custom serialization to plain JS may override toJSON() instead.
Shallowly converts this Record to equivalent native JavaScript Object.
Shallowly converts this Record to equivalent JavaScript Object.
Note: Not all methods can be used on a mutable collection or within
withMutations! Only set may be used mutatively.
Unlike other types in Immutable.js, the Record() function creates a new
Record Factory, which is a function that creates Record instances.
See above for examples of using Record().
Note: Record is a factory function and not a class, and does not use the
new keyword during construction.
Records allow passing a second parameter to supply a descriptive name that appears when converting a Record to a string or in any error messages. A descriptive name for any record can be accessed by using this method. If one was not provided, the string "Record" is returned.
const { Record } = require('immutable')
const Person = Record({
name: null
}, 'Person')
var me = Person({ name: 'My Name' })
me.toString() // "Person { "name": "My Name" }"
Record.getDescriptiveName(me) // "Person"True if maybeRecord is an instance of a Record.
Class for specifying a color.
Instances of Color are immutable, meaning that its setters don't modify the object, but instead return a completely new modified object.
Creation of Colors should be done with Factories, which affect various formats:
Watch out though, the color information is always stored in RGBA format with channels ranging [0, 255], regardless of how the information is supplied when created !