code-push

  • Version 4.0.5
  • Published
  • 107 kB
  • 6 dependencies
  • MIT license

Install

npm i code-push
yarn add code-push
pnpm add code-push

Overview

Management SDK for the CodePush service

Index

Classes

class AccountManager

class AccountManager {}

    constructor

    constructor(
    accessKey: string,
    customHeaders?: Headers,
    serverUrl?: string,
    proxy?: string
    );

      property accessKey

      readonly accessKey: string;

        property AppPermission

        static AppPermission: { OWNER: string; COLLABORATOR: string };

          method addAccessKey

          addAccessKey: (friendlyName: string, ttl?: number) => Promise<AccessKey>;

            method addApp

            addApp: (
            appName: string,
            appOs: string,
            appPlatform: string,
            manuallyProvisionDeployments?: boolean
            ) => Promise<App>;

              method addCollaborator

              addCollaborator: (appName: string, email: string) => Promise<void>;

                method addDeployment

                addDeployment: (appName: string, deploymentName: string) => Promise<Deployment>;

                  method clearDeploymentHistory

                  clearDeploymentHistory: (
                  appName: string,
                  deploymentName: string
                  ) => Promise<void>;

                    method getAccessKey

                    getAccessKey: (accessKeyName: string) => CodePushError;

                      method getAccessKeys

                      getAccessKeys: () => Promise<AccessKey[]>;

                        method getAccountInfo

                        getAccountInfo: () => Promise<Account>;

                          method getApp

                          getApp: (appName: string) => Promise<App>;

                            method getApps

                            getApps: () => Promise<App[]>;

                              method getCollaborators

                              getCollaborators: (appName: string) => Promise<CollaboratorMap>;

                                method getDeployment

                                getDeployment: (appName: string, deploymentName: string) => Promise<Deployment>;

                                  method getDeploymentHistory

                                  getDeploymentHistory: (
                                  appName: string,
                                  deploymentName: string
                                  ) => Promise<Package[]>;

                                    method getDeploymentMetrics

                                    getDeploymentMetrics: (
                                    appName: string,
                                    deploymentName: string
                                    ) => Promise<DeploymentMetrics>;

                                      method getDeployments

                                      getDeployments: (appName: string) => Promise<Deployment[]>;

                                        method getSessions

                                        getSessions: () => CodePushError;

                                          method isAuthenticated

                                          isAuthenticated: (throwIfUnauthorized?: boolean) => Promise<boolean>;

                                            method patchAccessKey

                                            patchAccessKey: (
                                            oldName: string,
                                            newName?: string,
                                            ttl?: number
                                            ) => CodePushError;

                                              method patchRelease

                                              patchRelease: (
                                              appName: string,
                                              deploymentName: string,
                                              label: string,
                                              updateMetadata: PackageInfo
                                              ) => Promise<void>;

                                                method promote

                                                promote: (
                                                appName: string,
                                                sourceDeploymentName: string,
                                                destinationDeploymentName: string,
                                                updateMetadata: PackageInfo
                                                ) => Promise<Package>;

                                                  method release

                                                  release: (
                                                  appName: string,
                                                  deploymentName: string,
                                                  filePath: string,
                                                  targetBinaryVersion: string,
                                                  updateMetadata: PackageInfo,
                                                  uploadProgressCallback?: (progress: number) => void
                                                  ) => Promise<Package>;

                                                    method removeAccessKey

                                                    removeAccessKey: (name: string) => Promise<void>;

                                                      method removeApp

                                                      removeApp: (appName: string) => Promise<void>;

                                                        method removeCollaborator

                                                        removeCollaborator: (appName: string, email: string) => Promise<void>;

                                                          method removeDeployment

                                                          removeDeployment: (appName: string, deploymentName: string) => Promise<void>;

                                                            method removeSession

                                                            removeSession: (machineName: string) => CodePushError;

                                                              method renameApp

                                                              renameApp: (oldAppName: string, newAppName: string) => Promise<void>;

                                                                method renameDeployment

                                                                renameDeployment: (
                                                                appName: string,
                                                                oldDeploymentName: string,
                                                                newDeploymentName: string
                                                                ) => Promise<void>;

                                                                  method rollback

                                                                  rollback: (
                                                                  appName: string,
                                                                  deploymentName: string,
                                                                  targetRelease?: string
                                                                  ) => Promise<void>;

                                                                    method transferApp

                                                                    transferApp: (appName: string, orgName: string) => Promise<void>;

                                                                      Package Files (2)

                                                                      Dependencies (6)

                                                                      Dev Dependencies (9)

                                                                      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/code-push.

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