Uint8

Utilities for working with the Uint8 type.

Added in 0.6.0

No other changes yet.

from "uint8" include Uint8

Values

Functions and constants included in the Uint8 module.

Uint8.fromNumber

Added in 0.6.0

No other changes yet.

fromNumber : (number: Number) => Uint8

Converts a Number to a Uint8.

Parameters:

param	type	description
`number`	`Number`	The value to convert

Returns:

type	description
`Uint8`	The Number represented as a Uint8

Uint8.toNumber

Added in 0.6.0

No other changes yet.

toNumber : (value: Uint8) => Number

Converts a Uint8 to a Number.

Parameters:

param	type	description
`value`	`Uint8`	The value to convert

Returns:

type	description
`Number`	The Uint8 represented as a Number

Uint8.fromInt8

Added in 0.6.0

No other changes yet.

fromInt8 : (number: Int8) => Uint8

Converts an Int8 to a Uint8.

Parameters:

param	type	description
`number`	`Int8`	The value to convert

Returns:

type	description
`Uint8`	The Int8 represented as a Uint8

Uint8.incr

Added in 0.6.0

No other changes yet.

incr : (value: Uint8) => Uint8

Increments the value by one.

Parameters:

param	type	description
`value`	`Uint8`	The value to increment

Returns:

type	description
`Uint8`	The incremented value

Uint8.decr

Added in 0.6.0

No other changes yet.

decr : (value: Uint8) => Uint8

Decrements the value by one.

Parameters:

param	type	description
`value`	`Uint8`	The value to decrement

Returns:

type	description
`Uint8`	The decremented value

Uint8.(+)

Added in 0.6.0

No other changes yet.

(+) : (x: Uint8, y: Uint8) => Uint8

Computes the sum of its operands.

Parameters:

param	type	description
`x`	`Uint8`	The first operand
`y`	`Uint8`	The second operand

Returns:

type	description
`Uint8`	The sum of the two operands

Uint8.(-)

Added in 0.6.0

No other changes yet.

(-) : (x: Uint8, y: Uint8) => Uint8

Computes the difference of its operands.

Parameters:

param	type	description
`x`	`Uint8`	The first operand
`y`	`Uint8`	The second operand

Returns:

type	description
`Uint8`	The difference of the two operands

Uint8.(*)

Added in 0.6.0

No other changes yet.

(*) : (x: Uint8, y: Uint8) => Uint8

Computes the product of its operands.

Parameters:

param	type	description
`x`	`Uint8`	The first operand
`y`	`Uint8`	The second operand

Returns:

type	description
`Uint8`	The product of the two operands

Uint8.(/)

Added in 0.6.0

No other changes yet.

(/) : (x: Uint8, y: Uint8) => Uint8

Computes the quotient of its operands.

Parameters:

param	type	description
`x`	`Uint8`	The first operand
`y`	`Uint8`	The second operand

Returns:

type	description
`Uint8`	The quotient of its operands

Uint8.rem

Added in 0.6.0

No other changes yet.

rem : (x: Uint8, y: Uint8) => Uint8

Computes the remainder of the division of its operands.

Parameters:

param	type	description
`x`	`Uint8`	The first operand
`y`	`Uint8`	The second operand

Returns:

type	description
`Uint8`	The remainder of its operands

Uint8.(<<)

Added in 0.6.0

No other changes yet.

(<<) : (value: Uint8, amount: Uint8) => Uint8

Shifts the bits of the value left by the given number of bits.

Parameters:

param	type	description
`value`	`Uint8`	The value to shift
`amount`	`Uint8`	The number of bits to shift by

Returns:

type	description
`Uint8`	The shifted value

Uint8.(>>>)

Added in 0.6.0

No other changes yet.

(>>>) : (value: Uint8, amount: Uint8) => Uint8

Shifts the bits of the value right by the given number of bits.

Parameters:

param	type	description
`value`	`Uint8`	The value to shift
`amount`	`Uint8`	The amount to shift by

Returns:

type	description
`Uint8`	The shifted value

Uint8.(==)

Added in 0.6.0

No other changes yet.

(==) : (x: Uint8, y: Uint8) => Bool

Checks if the first value is equal to the second value.

Parameters:

param	type	description
`x`	`Uint8`	The first value
`y`	`Uint8`	The second value

Returns:

type	description
`Bool`	`true` if the first value is equal to the second value or `false` otherwise

Uint8.(!=)

Added in 0.6.0

No other changes yet.

(!=) : (x: Uint8, y: Uint8) => Bool

Checks if the first value is not equal to the second value.

Parameters:

param	type	description
`x`	`Uint8`	The first value
`y`	`Uint8`	The second value

Returns:

type	description
`Bool`	`true` if the first value is not equal to the second value or `false` otherwise

Uint8.(<)

Added in 0.6.0

No other changes yet.

(<) : (x: Uint8, y: Uint8) => Bool

Checks if the first value is less than the second value.

Parameters:

param	type	description
`x`	`Uint8`	The first value
`y`	`Uint8`	The second value

Returns:

type	description
`Bool`	`true` if the first value is less than the second value or `false` otherwise

Uint8.(>)

Added in 0.6.0

No other changes yet.

(>) : (x: Uint8, y: Uint8) => Bool

Checks if the first value is greater than the second value.

Parameters:

param	type	description
`x`	`Uint8`	The first value
`y`	`Uint8`	The second value

Returns:

type	description
`Bool`	`true` if the first value is greater than the second value or `false` otherwise

Uint8.(<=)

Added in 0.6.0

No other changes yet.

(<=) : (x: Uint8, y: Uint8) => Bool

Checks if the first value is less than or equal to the second value.

Parameters:

param	type	description
`x`	`Uint8`	The first value
`y`	`Uint8`	The second value

Returns:

type	description
`Bool`	`true` if the first value is less than or equal to the second value or `false` otherwise

Uint8.(>=)

Added in 0.6.0

No other changes yet.

(>=) : (x: Uint8, y: Uint8) => Bool

Checks if the first value is greater than or equal to the second value.

Parameters:

param	type	description
`x`	`Uint8`	The first value
`y`	`Uint8`	The second value

Returns:

type	description
`Bool`	`true` if the first value is greater than or equal to the second value or `false` otherwise

Uint8.lnot

Added in 0.6.0

No other changes yet.

lnot : (value: Uint8) => Uint8

Computes the bitwise NOT of the given value.

Parameters:

param	type	description
`value`	`Uint8`	The given value

Returns:

type	description
`Uint8`	Containing the inverted bits of the given value

Uint8.(&)

Added in 0.6.0

No other changes yet.

(&) : (x: Uint8, y: Uint8) => Uint8

Computes the bitwise AND (&) on the given operands.

Parameters:

param	type	description
`x`	`Uint8`	The first operand
`y`	`Uint8`	The second operand

Returns:

type	description
`Uint8`	Containing a `1` in each bit position for which the corresponding bits of both operands are `1`

Uint8.(|)

Added in 0.6.0

No other changes yet.

(|) : (x: Uint8, y: Uint8) => Uint8

Computes the bitwise OR (|) on the given operands.

Parameters:

param	type	description
`x`	`Uint8`	The first operand
`y`	`Uint8`	The second operand

Returns:

type	description
`Uint8`	Containing a `1` in each bit position for which the corresponding bits of either or both operands are `1`

Uint8.(^)

Added in 0.6.0

No other changes yet.

(^) : (x: Uint8, y: Uint8) => Uint8

Computes the bitwise XOR (^) on the given operands.

Parameters:

param	type	description
`x`	`Uint8`	The first operand
`y`	`Uint8`	The second operand

Returns:

type	description
`Uint8`	Containing a `1` in each bit position for which the corresponding bits of either but not both operands are `1`