Options
All
  • Public
  • Public/Protected
  • All
Menu

Module bitburner/lib/deploy

A library for mass-deploying Bitburner scripts.

Index

Type aliases

Functions

Type aliases

DeployOptions

DeployOptions: { allowDeployOnHome: boolean }

Represents the various options which can be passed to deploy.

Type declaration

  • allowDeployOnHome: boolean

Deployment

Deployment: { args: (string | number | boolean)[]; hosts: { hostname: string; pid: number; threads: number }[]; script: string; threads: number }

Contains information on a set of mass-deployed scripts.

Type declaration

  • args: (string | number | boolean)[]
  • hosts: { hostname: string; pid: number; threads: number }[]
  • script: string
  • threads: number

Functions

deploy

  • deploy(ns: NS, script: string, threads: number | "MAX", args: (string | number | boolean)[], options?: DeployOptions): Promise<Deployment>

  • Automatically mass-deploy a script to as many servers as are needed to fulfill the desired number of threads.

    Parameters

    • ns: NS

      A Netscript context.

    • script: string

      The script to be deployed.

    • threads: number | "MAX"

      The desired number of threads.

    • args: (string | number | boolean)[]

      The arguments to be passed to the deployed script.

    • Optional options: DeployOptions

      Various options which modify the behavior of the deployment.

    Returns Promise<Deployment>

    An object containing details of how the script was deployed.

Generated using TypeDoc