Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@iota/converter

1.0.0-beta.30 • Public • Published

@iota/converter

Methods for converting ascii, values & trytes to trits and back.

Installation

Install using npm:

npm install @iota/converter

or using yarn:

yarn add @iota/converter

API Reference

converter.asciiToTrytes(input)

Summary: Converts ASCII characters to trytes.
Throws:

  • errors.INVALID_ASCII_CHARS : Make sure that the input argument contains only valid ASCII characters.
Param Type Description
input string ASCII input

This method converts ASCII characters to trytes.

Related methods

To convert trytes to ASCII characters, use the trytesToAscii() method.

Returns: string - Trytes
Example

let trytes = Converter.asciiToTrytes('Hello, where is my coffee?');

converter.trytesToAscii(trytes)

Summary: Converts trytes to ASCII characters.
Throws:

  • errors.INVALID_TRYTES : Make sure that the trytes argument contains only valid trytes (A-Z or 9).
  • errors.INVALID_ODD_LENGTH : Make sure that the trytes argument contains an even number of trytes.
Param Type Description
trytes string An even number of trytes

This method converts trytes to ASCII characters.

Because each ASCII character is represented as 2 trytes, the given trytes must be of an even length.

Related methods

To convert ASCII characters to trytes, use the asciiToTrytes() method.

Returns: string - ASCII characters
Example

let message = Converter.trytesToAscii('IOTA');

converter.trytesToTrits(input)

Summary: Converts trytes to trits.
Throws:

  • errors.INVALID_TRYTES : Make sure that the input argument contains only valid trytes (A-Z or 9).
Param Type Description
input String | number Trytes

This method converts trytes to trits.

Related methods

To convert ASCII characters to trytes, use the asciiToTrytes() method.

Returns: Int8Array - trits
Example

let trits = Converter.trytesToTrits('IOTA');

converter.tritsToTrytes(input)

Summary: Converts trits to trytes.
Throws:

  • errors.INVALID_TRITS : Make sure that the input argument contains an array of trits.
Param Type Description
input String | number Trits

This method converts trits to trytes.

Related methods

To convert trytes to ASCII characters, use the trytesToAscii() method.

Returns: Int8Array - trytes
Example

let trytes = Converter.tritsToTrytes(trits);

converter.tritsToValue(input)

Summary: Converts trits to a number.

Param Type Description
input String | number Trits

This method converts trits to a number.

Related methods

To convert trytes to trits, use the trytesToTrits() method. To convert trits to trytes, use the tritsToTrytes() method.

Returns: Int8Array - number
Example

let number = Converter.tritsToValue(trits);

converter.valueToTrits(input)

Summary: Converts trits to a number.

Param Type Description
input String | number Number

This method converts a number to trits.

Related methods

To convert trits to trytes, use the tritsToTrytes() method.

Returns: Int8Array - trits
Example

let trits = Converter.valueToTrits(9);

Install

npm i @iota/converter

DownloadsWeekly Downloads

1,251

Version

1.0.0-beta.30

License

MIT

Unpacked Size

55.1 kB

Total Files

31

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar