@janiscommerce/app-check-updates
TypeScript icon, indicating that this package has built-in type declarations

3.0.1 • Public • Published

@janiscommerce/app-check-updates

janis-logo

Coverage Status npm version

This package provides the functionality to detect when there is a new version of the app and notify the user

appCheckUpdates

It is checked by two means, in the first instance it is consulted in the store of the corresponding operating system, for cases where you work with apks and do not have access to the store, an api provided bi Janis will be searched, and if you have new versions, will additionally return the new version number.

Parameters

Options Type Description
buildNumber (required) String The build number of your current app version
env (required) String Janis environment where we are working
app (required) String Application we work on

updateFromJanis

This function is responsible for downloading the apk of the new version using an api provided by janis.

Parameters

Options Type Description
newVersionNumber (required) String The new version number of the app
env (required) String Janis environment where we are working
app (required) String Application we work on

Installation

The minimum required versions for using the package are react: 17.0.2 and react-native: 0.67.5.

npm install @janiscommerce/app-check-updates

This package uses peer dependencies that you have to install it manually in your application.

sp-react-native-in-app-updates.

npm install sp-react-native-in-app-updates@1.2.0

react-native-fs.

npm i react-native-fs

Usage Example

import React, {useEffect} from 'react';
import {View, Text} from 'react-native';
import {appCheckUpdates, updateFromJanis} from '@janiscommerce/app-check-updates';

const App = () => {
	useEffect(async () => {
  		const {hasCheckedUpdate, shouldUpdateFromJanis, newVersionNumber} = await appCheckUpdates({
			buildNumber: "2350",
			env: "janisqa",
			app: 'picking',
		});
		if (shouldUpdateFromJanis) {
			await updateFromJanis({
				env: "janisqa",
				app: 'picking',
				newVersionNumber: newVersionNumber,
			});
		}
	}, []);

	return (
		<View>
			<Text>app check updates</Text>
		</View>
	);
};

ReactDOM.render(<App />, document.querySelector('#app'));

Readme

Keywords

none

Package Sidebar

Install

npm i @janiscommerce/app-check-updates

Weekly Downloads

16

Version

3.0.1

License

ISC

Unpacked Size

17.7 kB

Total Files

10

Last publish

Collaborators

  • janiscommerce