Skip to content

Latest commit

 

History

History
67 lines (50 loc) · 1.18 KB

README.md

File metadata and controls

67 lines (50 loc) · 1.18 KB

@naverwhale/installer

Naver Whale installler for web application.

Installation

npm i @naverwhale/installer

Usage

import installer from '@naverwhale/installer';

// Install the Whale browser for the current environment.
installer.install();

// Get installation url for the current environment.
installer.getInstallURL();

API

install

Install the Whale browser. You can specify the environment to install with parameter, if not, it will be set as the current environment.

// current environment.
installer.install();
// or window
installer.install('win');

getInstallURL

Returns the Whale browser install url. You can specify the environment to install with parameter, if not, it will be set as the current environment.

// current environment.
installer.getInstallURL();
// or window
installer.getInstallURL('win');

Types

interface Installer {
    install: (platform?: Platform) => void;
    getInstallURL: (platform?: Platform) => string;
}

type Platform =
    | 'win'
    | 'win_32'
    | 'win_64'
    | 'win_arm'
    | 'win_beta'
    | 'mac'
    | 'mac_arm'
    | 'linux'
    | 'iphone'
    | 'ipad'
    | 'android';