Logo for jsDocs.io

@types/launchpad

  • Version 0.6.4
  • Published
  • 5.3 kB
  • No dependencies
  • MIT license

Install

npm i @types/launchpad
yarn add @types/launchpad
pnpm add @types/launchpad

Overview

TypeScript definitions for launchpad

Index

Functions

Interfaces

Namespaces

Functions

function browserstack

browserstack: (
    authCreds: BrowserstackAuth,
    cb: (err: any, browserstack: Launcher) => void
) => void;

    function local

    local: typeof local;

    • For launching local browsers. The callback will be given a Launcher to perform the actual launching.

    Interfaces

    interface Browser

    interface Browser {}

      property binPath

      binPath: string;

        property name

        name: string;

          property version

          version: string;

            interface BrowserFunction

            interface BrowserFunction {}

              call signature

              (url: string, callback: (err: any, instance: Instance) => void): void;

                interface BrowserPlatformDetails

                interface BrowserPlatformDetails {}

                  property args

                  args?: string[] | undefined;

                    property command

                    command?: string | undefined;

                      property cwd

                      cwd?: string | undefined;

                        property defaultLocation

                        defaultLocation?: string | undefined;

                          property getCommand

                          getCommand?:
                              | ((browser: BrowserPlatformDetails, url: string, args: string[]) => string)
                              | undefined;

                            property imageName

                            imageName?: string | undefined;

                              property multi

                              multi?: boolean | undefined;

                                property opensTab

                                opensTab?: boolean | undefined;

                                  property pathQuery

                                  pathQuery?: string | undefined;

                                    property plistPath

                                    plistPath?: string | undefined;

                                      property process

                                      process?: string | undefined;

                                        property versionKey

                                        versionKey?: string | undefined;

                                          interface BrowserstackAuth

                                          interface BrowserstackAuth {}

                                            property password

                                            password: string;

                                              property username

                                              username: string;

                                                interface Instance

                                                interface Instance {}

                                                  property id

                                                  id: string;

                                                    method addListener

                                                    addListener: (event: string, listener: Function) => this;

                                                      method emit

                                                      emit: (event: string, ...args: any[]) => boolean;

                                                        method listeners

                                                        listeners: (event: string) => Function[];

                                                          method on

                                                          on: (event: string, listener: Function) => this;

                                                            method once

                                                            once: (event: string, listener: Function) => this;

                                                              method removeAllListeners

                                                              removeAllListeners: (event?: string) => this;

                                                                method removeListener

                                                                removeListener: (event: string, listener: Function) => this;

                                                                  method setMaxListeners

                                                                  setMaxListeners: (n: number) => void;

                                                                    method status

                                                                    status: (cb: (err: any, status: any) => void) => void;

                                                                      method stop

                                                                      stop: (cb: (err: any) => void) => void;

                                                                        interface Launcher

                                                                        interface Launcher {}

                                                                          property aurora

                                                                          aurora: BrowserFunction;

                                                                            property canary

                                                                            canary: BrowserFunction;

                                                                              property chrome

                                                                              chrome: BrowserFunction;

                                                                                property chromium

                                                                                chromium: BrowserFunction;

                                                                                  property edge

                                                                                  edge: BrowserFunction;

                                                                                    property firefox

                                                                                    firefox: BrowserFunction;

                                                                                      property ie

                                                                                      ie: BrowserFunction;

                                                                                        property nodeWebkit

                                                                                        nodeWebkit: BrowserFunction;

                                                                                          property opera

                                                                                          opera: BrowserFunction;

                                                                                            property phantom

                                                                                            phantom: BrowserFunction;

                                                                                              property safari

                                                                                              safari: BrowserFunction;

                                                                                                method browsers

                                                                                                browsers: (cb: (error: any, browsers?: Browser[]) => void) => void;

                                                                                                  call signature

                                                                                                  (
                                                                                                      url: string,
                                                                                                      options: LaunchOptions,
                                                                                                      callback: (err: any, instance: Instance) => void
                                                                                                  ): void;

                                                                                                    interface LaunchOptions

                                                                                                    interface LaunchOptions {}

                                                                                                      property browser

                                                                                                      browser: string;

                                                                                                        property version

                                                                                                        version?: string | undefined;

                                                                                                          Namespaces

                                                                                                          namespace local

                                                                                                          namespace local {}

                                                                                                            variable platform

                                                                                                            const platform: {
                                                                                                                chrome?: BrowserPlatformDetails | undefined;
                                                                                                                chromium?: BrowserPlatformDetails | undefined;
                                                                                                                canary?: BrowserPlatformDetails | undefined;
                                                                                                                firefox?: BrowserPlatformDetails | undefined;
                                                                                                                aurora?: BrowserPlatformDetails | undefined;
                                                                                                                opera?: BrowserPlatformDetails | undefined;
                                                                                                                ie?: BrowserPlatformDetails | undefined;
                                                                                                                edge?: BrowserPlatformDetails | undefined;
                                                                                                                safari?: BrowserPlatformDetails | undefined;
                                                                                                                phantom?: BrowserPlatformDetails | undefined;
                                                                                                                nodeWebkit?: BrowserPlatformDetails | undefined;
                                                                                                            };

                                                                                                              Package Files (1)

                                                                                                              Dependencies (0)

                                                                                                              No dependencies.

                                                                                                              Dev Dependencies (0)

                                                                                                              No dev dependencies.

                                                                                                              Peer Dependencies (0)

                                                                                                              No peer dependencies.

                                                                                                              Badge

                                                                                                              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/launchpad.

                                                                                                              • Markdown
                                                                                                                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/launchpad)
                                                                                                              • HTML
                                                                                                                <a href="https://www.jsdocs.io/package/@types/launchpad"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>