History

Richard Moore 261eb04e97 Ignore metadata files in each package.		2020-09-22 22:57:17 -04:00
..
lib	Updated dist files.	2020-09-11 02:10:58 -04:00
lib.esm	Updated dist files.	2020-09-11 02:10:58 -04:00
src.ts	Updated dist files.	2020-09-11 02:10:58 -04:00
.npmignore	Ignore metadata files in each package.	2020-09-22 22:57:17 -04:00
LICENSE.md	Initial v5 branch commit.	2019-05-14 18:25:46 -04:00
package.json	Updated dist files.	2020-09-11 02:10:58 -04:00
README.md	Updated docs for all packages on npm pages (#1013 ).	2020-08-25 01:09:48 -04:00
tsconfig.json	Major overhaul in compilation to enable ES6 module generation.	2019-08-25 02:39:20 -04:00

README.md

String Manipulation Utilities

This sub-module is part of the ethers project.

It contains functions to safely convert between UTF-8 data, strings and Bytes32 strings (i.e. "short strings").

For more information, see the documentation.

Importing

Most users will prefer to use the umbrella package, but for those with more specific needs, individual components can be imported.

const {

    toUtf8Bytes,
    toUtf8CodePoints,
    toUtf8String,

    formatBytes32String,
    parseBytes32String,

    nameprep

    // Enums

    Utf8ErrorFuncs,
    Utf8ErrorReason,

    UnicodeNormalizationForm

    // Types

    Utf8ErrorFunc,

} = require("@ethersproject/strings");

License

MIT License