Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 1.55 KB

README.md

File metadata and controls

58 lines (40 loc) · 1.55 KB

Typescript React Example

This example shows how to use the @ar.io/sdk within a Typescript/React project.

Getting Started

  1. Install the dependencies:
yarn
  1. Start the development server:
yarn start
  1. Open your browser and navigate to http://localhost:3000. You should see:

screenshot

Polyfills

The @ar.io/sdk uses some modern browser features that may not be available in all browsers. To ensure compatibility, you may need to include some polyfills. This example uses the node-polyfill-webpack-plugin plugin to include the necessary polyfills.

The tsconfig.json includes the following compiler options:

{
  "compilerOptions": {
    "moduleResolution": "Bundler", // or nodenext are reccomended to use named exports (e.g. @ar.io/sdk/web)
    "lib": ["es2015", "dom"]
  }
}

The webpack.config.js file includes the following polyfills required for the @ar.io/sdk:

const NodePolyfillPlugin = require('node-polyfill-webpack-plugin');

module.exports = {
  // other webpack configuration
  resolve: {
    fallback: {
      fs: require.resolve('browserify-fs'), // not provided by NodePolyfills, so provide it here
    },
  },
  polyfills: [new NodePolyfills()], // supports core node packages like `crypto`, `process`, etc.
};

If you are using a bundler other than Webpack, you may need to include the necessary polyfills in a similar way.

`;