react-native-freeotp

Native module for generating the same TOTP tokens as FreeOTP from your React Native app.

Usage no npm install needed!

<script type="module">
  import reactNativeFreeotp from 'https://cdn.skypack.dev/react-native-freeotp';
</script>

README

react-native-freeotp

Native module for generating the same TOTP tokens as FreeOTP from your React Native app.

Installation

npm install react-native-freeotp

Android

Rebuild the app.

iOS

Install the pod, then rebuild the app.

npx pod-install

Usage

import FreeOtp from 'react-native-freeotp';

const tokenPair = await FreeOtp.getTokenPair(totpUrl);

Types

Result:

type TokenPair = {
  /**
   * Current token.
   */
  tokenOne: string;
  /**
   * Next period step token.
   */
  tokenTwo: string;
  /**
   * Seconds until expiry of the current token.
   */
  tokenOneExpires: string;
  /**
   * Seconds until expiry of the next token.
   */
  tokenTwoExpires: string;
};

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT