gozala / web-encoding Goto Github PK

8.0 4.0 5.0 777 KB

TextEncoder and TextDecoder APIs from Encoding Standard APIs in a universal package

JavaScript 92.83% TypeScript 7.17%

textencoder textdecoder web js

web-encoding's Introduction

web-encoding

This package provides TextEncoder and TextDecoder Encoding Standard APIs in a universal package. In the browsers it just exposes existing globals, in nodejs it exposes globals in newer node versions and ones from util module in older versions, and in the React Native environments it exposes these from the @zxing/text-encoding polyfill (installed as an optional dependency).

Package also works as ES module and CommonJS module.

Usage

import { TextEncoder, TextDecoder } from "web-encoding"

Install

npm install web-encoding

web-encoding's People

Contributors

Stargazers

Watchers

Forkers

auhau somay achingbrain alive2 msftenhanceprovenance

web-encoding's Issues

Cant find variableTextEncoder

In lib.browser.js, react native throws me that error.

I have installed v1.0.4

@zxing/text-encoding doesnt exist any more

@zxing/text-encoding

jest --env=jsdom TypeError: TextDecoder is not a constructor

jest with --env=jsdom fails with TypeError: TextDecoder is not a constructor

@Gozala did not dig into it, but I assume this is a bug: it is fair to expect people use js-multiaddr (which depends on web-encoding) in apps tested with jest.

That's what we do in ipfs-webui – see below.

How to reproduce

Having below in multibase/src/util.js causes jest-based tests to fail in ipfs-webui:

example in PR: ipfs/ipfs-webui#1689
- failed job: https://app.circleci.com/pipelines/github/ipfs-shipyard/ipfs-webui/708/workflows/ce65ef3d-3ba5-4b2f-8cab-9352d49fd458/jobs/4738

const { TextEncoder, TextDecoder } = require('web-encoding')
const textDecoder = new TextDecoder()

 FAIL  src/bundles/analytics.test.js
  ● Test suite failed to run

    TypeError: TextDecoder is not a constructor

    > 1 | import multiaddr from 'multiaddr'
        | ^
      2 | // @ts-ignore
      3 | import HttpClient from 'ipfs-http-client'
      4 | // @ts-ignore

      at Object.<anonymous> (node_modules/uint8arrays/node_modules/multibase/src/util.js:6:21)
      at Object.<anonymous> (node_modules/uint8arrays/node_modules/multibase/src/base.js:4:24)
      at Object.<anonymous> (node_modules/uint8arrays/node_modules/multibase/src/constants.js:5:14)
      at Object.<anonymous> (node_modules/uint8arrays/to-string.js:3:19)

Problems with jest in env=node and env=jsdom

As per multiformats/js-multibase#66 (quoting below):

Describe the bug
When running the test in jest (with either env=jsdom or env=node setting) the TextDecoder or TextEncoder is not a constructor error makes it impossible to write unit tests using this module

To Reproduce
This simple test and code fails to run in jest
code:
https://github.com/Uniswap/uniswap-interface/blob/0aabf4856e6e90041caf4233db4b7defb01574a2/src/utils/contenthashToUri.ts
test:
https://github.com/Uniswap/uniswap-interface/blob/0aabf4856e6e90041caf4233db4b7defb01574a2/src/utils/contenthashToUri.test.skip.ts

error:
TypeError: TextDecoder is not a constructor
    TypeError: TextDecoder is not a constructor

    > 1 | import CID from 'cids'
        | ^
      2 | import { getCodec, rmPrefix } from 'multicodec'
      3 | import { decode, toB58String } from 'multihashes'
      4 |

      at Object.<anonymous> (node_modules/multibase/src/util.js:6:21)
      at Object.<anonymous> (node_modules/multibase/src/base.js:4:24)
      at Object.<anonymous> (node_modules/multibase/src/constants.js:5:14)
      at Object.<anonymous> (node_modules/multibase/src/index.js:9:19)
      at Object.<anonymous> (node_modules/multihashes/src/index.js:10:19)
      at Object.<anonymous> (node_modules/cids/src/index.js:3:12)
      at Object.<anonymous> (src/utils/contenthashToUri.ts:1:1)
      at Object.<anonymous> (src/utils/contenthashToUri.test.ts:1:1)
Expected behavior
TextDecoder from the environment (specifically, global for node and window for jsdom jest setting) is successfully loaded

Screenshots

Desktop (please complete the following information):

OS: MacOS

Latest version is broken in browserify?

Seeing this in CI:

example-browser-browserify: > [email protected] test /home/travis/build/ipfs/js-ipfs/examples/browser-browserify
example-browser-browserify: > test-ipfs-example
example-browser-browserify: > [email protected] bundle /home/travis/build/ipfs/js-ipfs/examples/browser-browserify
example-browser-browserify: > browserify src/index.js > public/bundle.js
example-browser-browserify: /home/travis/build/ipfs/js-ipfs/node_modules/web-encoding/src/lib.js:7
example-browser-browserify: export { Encoder as TextEncoder, Decoder as TextDecoder }
example-browser-browserify: ^
example-browser-browserify: ParseError: 'import' and 'export' may appear only with 'sourceType: module'

Publish a new release to NPM to include "repository" field

Hi, I can see that the latest PR merged to main added a repository field to the package.json.

It would be lovely if you could publish this change in a patch release so that the NPM page correctly links to this repo :)

Thanks!

TS compilation issue

When I run tsc in achingbrain's uint8arrays repo I get:

node_modules/web-encoding/src/lib.d.ts:1:10 - error TS2661: Cannot export 'TextEncoder'. Only local declarations can be exported from a module.

1 export { TextEncoder, TextDecoder }
           ~~~~~~~~~~~

node_modules/web-encoding/src/lib.d.ts:1:23 - error TS2661: Cannot export 'TextDecoder'. Only local declarations can be exported from a module.

1 export { TextEncoder, TextDecoder }
                        ~~~~~~~~~~~

Publish v1.0.5 to NPM

Can you publish v1.0.5 to npm?