JavaScript Package Documentation

https://www.jsdocs.io/package/
Admin
This project provides documentation for a wide range of JavaScript and Node.js packages, detailing...
Tokens:29,295,050
Snippets:388,476
Trust Score:7.9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Quickstart Example

Source: https://www.jsdocs.io/package/@google-cloud/logging-winston

A full quickstart example demonstrating the usage of the LoggingWinston transport.

```javascript
/**
 * @license
 * Copyright 2020 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

// [START logging_winston_quickstart]

// Import the Winston and LoggingWinston libraries.
const winston = require('winston');
const {LoggingWinston} = require('@google-cloud/logging-winston');

// Create a Winston logger that streams to Cloud Logging.
const logger = winston.createLogger({
  level: 'info',
  format: winston.format.json(),
  transports: [
    new winston.transports.Console({
      format: winston.format.simple(),
    }),
    // Add Cloud Logging as a transport.
    new LoggingWinston(),
  ],
});

// Log a message.
logger.info('Hello, Winston!');

// Log an error.
logger.error('This is an error message.');

// Log an object with metadata.
logger.log('warn', {
  message: 'User logged out',
  details: {
    userId: '123',
    sessionId: 'abc',
  },
});

// [END logging_winston_quickstart]

```

--------------------------------

### Install 'start' with yarn

Source: https://www.jsdocs.io/package/start

Use this command to install the 'start' package using yarn.

```bash
yarn add start
```

--------------------------------

### Add Player Example

Source: https://www.jsdocs.io/package/tone

Example of adding a player with a URL and logging a message when it's loaded, then starting it.

```javascript
const players = new Tone.Players(); players.add("gong", "https://tonejs.github.io/audio/berklee/gong_1.mp3", () => { console.log("gong loaded"); players.player("gong").start(); });
```

--------------------------------

### Example: Setting Project Annotations in Setup File

Source: https://www.jsdocs.io/package/@storybook/angular

Illustrates how to import and set project annotations from a preview file in a setup file for global configuration.

```typescript
// setup-file.js
import { setProjectAnnotations } from '@storybook/angular';


import projectAnnotations from './.storybook/preview';


setProjectAnnotations(projectAnnotations);

```

--------------------------------

### Example: Setting Project Annotations in setup-file.js

Source: https://www.jsdocs.io/package/@storybook/web-components

This example demonstrates how to import and set project annotations in your Storybook setup file to apply global configurations like decorators.

```javascript
// setup-file.js
import { setProjectAnnotations } from '@storybook/web-components';
import projectAnnotations from './.storybook/preview';


setProjectAnnotations(projectAnnotations);
```

--------------------------------

### Composer Property: messages

Source: https://www.jsdocs.io/package/vue-i18n

A computed property exposing the locale messages for localization. See Getting Started guide.

```typescript
readonly messages: ComputedRef<{ [K in keyof Messages]: Messages[K]; }>;

```

--------------------------------

### Vue I18n Property: messages

Source: https://www.jsdocs.io/package/vue-i18n

Provides read-only access to the locale messages of localization. Refer to the Getting Started guide for more details.

```typescript
readonly messages: {
    [K in keyof Messages]: Messages[K];
};
```

--------------------------------

### setup()

Source: https://www.jsdocs.io/package/@pnp/common

Sets up the PnP configuration with provided options.

```APIDOC
## setup()

### Description
Sets up the PnP configuration with provided options.

### Function Signature
setup(config: IConfigOptions): void

### Parameters
* **config** (IConfigOptions) - The configuration options for PnP.

### Returns
* (void)
```

--------------------------------

### setup()

Source: https://www.jsdocs.io/package/qunit-dom

Initializes qunit-dom with QUnit's assert object and optional configuration options.

```APIDOC
## setup()

### Description
Initializes qunit-dom with QUnit's assert object and optional configuration options.

### Signature
```typescript
setup: (assert: Assert, options?: SetupOptions) => void;
```

### Parameters
#### assert
- **assert** (Assert) - Required - The QUnit assert object.

#### options
- **options** (SetupOptions) - Optional - Configuration options for setup.

### Type Aliases
#### Assert
```typescript
type Assert = IAssert;
```

#### DOMTarget
```typescript
type DOMTarget = string | Element | IDOMElementDescriptor | null;
```

#### RootElement
```typescript```
type RootElement = TRoot;
```
```

--------------------------------

### Luxon endOf Week Example

Source: https://www.jsdocs.io/package/@types/luxon

Demonstrates using `endOf` to get the last millisecond of a week, noting that weeks start on Mondays.

```javascript
DateTime.local(2014, 3, 3).endOf('week').toISO(); // => '2014-03-09T23:59:59.999-05:00', weeks start on Mondays
```

--------------------------------

### Get Repository Installation

Source: https://www.jsdocs.io/package/@octokit/types

Gets the installation for a repository.

```APIDOC
## GET /repos/{owner}/{repo}/installation

### Description
Gets the installation for a repository.

### Method
GET

### Endpoint
/repos/{owner}/{repo}/installation
```

--------------------------------

### setup

Source: https://www.jsdocs.io/package/react-dnd-touch-backend

Sets up the touch backend, initializing necessary event listeners and internal states.

```APIDOC
## method setup

### Description
Sets up the touch backend, initializing necessary event listeners and internal states.
```

--------------------------------

### Setup and Run Cycle.js Application

Source: https://www.jsdocs.io/package/@cycle/run

Example demonstrating the setup() function to prepare a Cycle.js application. It returns sources, sinks, and a run function, allowing for delayed execution and providing access to intermediate states.

```javascript
import {setup} from '@cycle/run';
const {sources, sinks, run} = setup(main, drivers);
// ...
const dispose = run(); // Executes the application
// ...
dispose();
```

--------------------------------

### Get TextSpan Start

Source: https://www.jsdocs.io/package/ts-simple-ast

Gets the starting position of the text span.

```typescript
getStart: () => number;
```

--------------------------------

### Application Setup Method

Source: https://www.jsdocs.io/package/@feathersjs/feathers

Sets up the application and calls the `.setup` method on all registered services.

```typescript
setup: (server?: any) => Promise<this>;
```

--------------------------------

### Install 'start' with pnpm

Source: https://www.jsdocs.io/package/start

Use this command to install the 'start' package using pnpm.

```bash
pnpm add start
```

--------------------------------

### setup

Source: https://www.jsdocs.io/package/xstate

Configures and initializes a machine with various options like actors, actions, guards, and delays.

```APIDOC
## function setup

### Description
Configures and initializes a machine with various options like actors, actions, guards, and delays.

### Parameters
- **schemas**: unknown - Optional - Schema definitions.
- **types**: SetupTypes - Optional - Type definitions for the setup.
- **actors**: object - Optional - Actor definitions.
- **actions**: object - Optional - Action definitions.
- **guards**: object - Optional - Guard predicate definitions.
- **delays**: object - Optional - Delay configuration definitions.
- **[K in RequiredSetupKeys<TChildrenMap>]**: unknown - Required - Keys for child map setup.
```

--------------------------------

### PBKDF2 Create Examples

Source: https://www.jsdocs.io/package/@types/crypto-js

Examples of creating PBKDF2 instances with default and custom configurations.

```javascript
var kdf = CryptoJS.algo.PBKDF2.create(); var kdf = CryptoJS.algo.PBKDF2.create({ keySize: 8 }); var kdf = CryptoJS.algo.PBKDF2.create({ keySize: 8, iterations: 1000 });
```

--------------------------------

### Install 'start' with npm

Source: https://www.jsdocs.io/package/start

Use this command to install the 'start' package using npm.

```bash
npm i start
```

--------------------------------

### Package Dependencies Example

Source: https://www.jsdocs.io/package/@jsdocs-io/extractor

Illustrates how installing a package can bring in its dependencies. This example shows that installing 'foo' also installs 'bar' and 'baz'.

```typescript
dependencies: string[];

// Installing `foo` brings in also `bar` and `baz` as dependencies. ["foo@1.0.0", "bar@2.0.0", "baz@3.0.0"]
```

--------------------------------

### GUID Property for Installers

Source: https://www.jsdocs.io/package/app-builder-lib

Specifies the installer's GUID for upgrade and uninstall. A deterministic GUID is generated from appId if not provided, but changing appId will break silent upgrades.

```typescript
readonly guid?: string | null;
```

--------------------------------

### GET /app/installations/{installation_id}

Source: https://www.jsdocs.io/package/@octokit/types

Gets a specific installation for the GitHub App. This endpoint retrieves details about a single installation.

```APIDOC
## GET /app/installations/{installation_id}

### Description
Gets a specific installation for the GitHub App.

### Method
GET

### Endpoint
/app/installations/{installation_id}
```

--------------------------------

### startNew

Source: https://www.jsdocs.io/package/@jupyterlab/services

Start a new kernel with specified options.

```APIDOC
## startNew

### Description
Start a new kernel with specified options. The manager `serverSettings` will always be used.

### Method
(Not explicitly defined, but typically a POST operation to create a resource)

### Endpoint
(Not explicitly defined, but would typically be a collection endpoint for kernels)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
- **createOptions** (IKernelOptions) - Optional - The kernel creation options, including the kernel name.
- **connectOptions** (Omit<IKernelConnection.IOptions, 'model' | 'serverSettings'>) - Optional - The kernel connection options.

### Request Example
```json
{
  "createOptions": {
    "name": "python3"
  },
  "connectOptions": {
    // ... connection options
  }
}
```

### Returns
#### Success Response (200)
- **IKernelConnection** - A promise that resolves with the kernel connection object.

### Response Example
(No explicit response example provided in source)
```

--------------------------------

### Config Create and Write Example

Source: https://www.jsdocs.io/package/@salesforce/core

Demonstrates creating a local Config instance, setting a 'target-org' property, and writing the changes to a configuration file.

```typescript
const localConfig = await Config.create();
localConfig.set('target-org', 'username@company.org');
await localConfig.write();
```

--------------------------------

### Get Node Start Line Number

Source: https://www.jsdocs.io/package/ts-simple-ast

Gets the line number at the start of the node, optionally including the JSDoc comment.

```typescript
getStartLineNumber: (includeJsDocComment?: boolean) => number;
```

--------------------------------

### Get Node Start Line Position

Source: https://www.jsdocs.io/package/ts-simple-ast

Gets the position of the start of the line where the node begins, optionally including the JSDoc comment.

```typescript
getStartLinePos: (includeJsDocComment?: boolean) => number;
```

--------------------------------

### Example: Command.action

Source: https://www.jsdocs.io/package/commander

Example of registering an action for a 'serve' command.

```javascript
program
  .command('serve')
  .description('start service')
  .action(function() {
    // do work here
  });
```

--------------------------------

### Help Command Configuration Examples

Source: https://www.jsdocs.io/package/commander

Examples showing how to customize or disable the default help command.

```javascript
program.helpCommand('help [cmd]');
program.helpCommand('help [cmd]', 'show help');
program.helpCommand(false); // suppress default help command
program.helpCommand(true); // add help command even if no subcommands
```

--------------------------------

### Get Node Start Position

Source: https://www.jsdocs.io/package/ts-simple-ast

Gets the starting position of the node in the source file text, optionally including the JSDoc comment.

```typescript
getStart: (includeJsDocComment?: boolean) => number;
```

--------------------------------

### GET App Installation Requests Type

Source: https://www.jsdocs.io/package/@octokit/types

Defines the type for the GET /app/installation-requests operation, used to list installation requests for an app.

```typescript
'GET /app/installation-requests': ReadonlyOperation<
    '/app/installation-requests',
    'get'
>;
```

--------------------------------

### Login Examples

Source: https://www.jsdocs.io/package/@types/passport

Examples demonstrating how to use the login method with and without session options.

```javascript
req.logIn(user, { session: false });
req.logIn(user, function(err) { if (err) { throw err; } // session saved });
```

--------------------------------

### Get and Update Plugin Instance Example

Source: https://www.jsdocs.io/package/@antv/g6

Examples of getting a plugin instance by key and updating plugin options using the graph API.

```javascript
// Get plugin instance
const plugin = graph.getPluginInstance('key');
// Update plugin options
graph.updatePlugin({key: 'key', ...});
```

--------------------------------

### ResolveDependencies Example

Source: https://www.jsdocs.io/package/injection-js

Example demonstrating the use of `resolveDependencies` to get an array of dependencies for given classes. It also shows how to create an injector and get an instance.

```javascript
class HTTP {}
class Database {}


// commenting out the decorator because the `@` symbol is spoiling
// jsDoc rendering in vscode
// @Injectable()
class PersonService {
  constructor(
    private http: HTTP,
    private database: Database,
  ) {}
}


// @Injectable()
class OrganizationService {
  constructor(
    private http: HTTP,
    private personService: PersonService,
  ) {}
}


const injector = ReflectiveInjector.resolveAndCreate(
  resolveDependencies(OrganizationService)
);


const organizationService = injector.get(OrganizationService);
```

--------------------------------

### setup

Source: https://www.jsdocs.io/package/@pnp/common

Sets up the library configuration.

```APIDOC
## setup

### Description
Sets up the library configuration with optional runtime information.

### Method
(Not specified, likely a utility function call)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Parameters
#### config
- **config** (T) - Required - The library configuration object.
#### runtime
- **runtime** (Runtime) - Optional - The runtime information.
```

--------------------------------

### EvpKDF Create Method Examples

Source: https://www.jsdocs.io/package/@types/crypto-js

Shows examples of creating an EvpKDF instance with default settings or custom configurations for key size and iterations.

```javascript
var kdf = CryptoJS.algo.EvpKDF.create(); var kdf = CryptoJS.algo.EvpKDF.create({ keySize: 8 }); var kdf = CryptoJS.algo.EvpKDF.create({ keySize: 8, iterations: 1000 });
```

--------------------------------

### Server Setup and Start

Source: https://www.jsdocs.io/package/grpc

Demonstrates the basic setup and startup sequence for a gRPC server. This involves adding proto services, binding to an address, and starting the server.

```javascript
var server = new grpc.Server();
server.addProtoService(protobuf_service_descriptor, service_implementation);
server.bind('address:port', server_credential);
server.start();
```

--------------------------------

### serve

Source: https://www.jsdocs.io/package/@ionic/app-scripts

Starts a development server with the provided build context and returns server configuration.

```APIDOC
## serve

### Description
Starts a development server with the provided build context and returns server configuration.

### Signature
```typescript
serve: (context: BuildContext) => Promise<ServeConfig>;
```
```

--------------------------------

### Get Start Position Method

Source: https://www.jsdocs.io/package/tslint

Retrieves the start position of a RuleFailure.

```typescript
getStartPosition: () => RuleFailurePosition;
```

--------------------------------

### Get Firebase Installation ID

Source: https://www.jsdocs.io/package/@firebase/installations

Creates a Firebase Installation if one doesn't exist and returns the Installation ID. Requires an Installations instance.

```typescript
getId: (installations: Installations) => Promise<string>;
```

--------------------------------

### start

Source: https://www.jsdocs.io/package/@phosphor/application

Starts the application, initiating the bootstrapping process which includes activating startup plugins, mounting the shell to the DOM, and adding event listeners. Resolves when all bootstrapping is complete.

```APIDOC
## start(options?: Application.IStartOptions)

### Description
Start the application.

### Parameters
#### Path Parameters
- **options** (Application.IStartOptions) - Optional - The options for starting the application.

### Returns
A promise which resolves when all bootstrapping work is complete and the shell is mounted to the DOM.

### Notes
This should be called once by the application creator after all initial plugins have been registered. If a plugin fails to the load, the error will be logged and the other valid plugins will continue to be loaded. Bootstrapping the application consists of the following steps: 1. Activate the startup plugins 2. Wait for those plugins to activate 3. Attach the shell widget to the DOM 4. Add the application event listeners

### Method Signature
`start: (options?: Application.IStartOptions) => Promise<void>`
```

--------------------------------

### Get augmented PATH string

Source: https://www.jsdocs.io/package/npm-run-path

Demonstrates how to get the augmented PATH string by prepending locally installed binaries. This is useful for running executables installed in local `node_modules/.bin`.

```typescript
import childProcess from 'node:child_process';
import {npmRunPath} from 'npm-run-path';


console.log(process.env.PATH);
//=> '/usr/local/bin'


console.log(npmRunPath());
//=> '/Users/sindresorhus/dev/foo/node_modules/.bin:/Users/sindresorhus/dev/node_modules/.bin:/Users/sindresorhus/node_modules/.bin:/Users/node_modules/.bin:/node_modules/.bin:/usr/local/bin'
```

--------------------------------

### setup Method

Source: https://www.jsdocs.io/package/@sentry/core

Sets up an integration for a specific client. Prefer this over setupOnce for client-specific setup logic.

```typescript
setup: (client: Client) => void;

```

--------------------------------

### Setup Methods Function

Source: https://www.jsdocs.io/package/@0x/typescript-typings

Defines a function 'setupMethods' that takes solc binary and returns a SolcInstance.

```typescript
setupMethods: (solcBin: any) => SolcInstance;
```

--------------------------------

### Loc Start Property

Source: https://www.jsdocs.io/package/prettier

A function to get the start location of a node in the AST.

```typescript
locStart: (node: T) => number;

```

--------------------------------

### Get value from UIInjector (example)

Source: https://www.jsdocs.io/package/@uirouter/core

Example of retrieving a resolve value from the UIInjector.

```javascript
var myResolve = injector.get('myResolve');
```

--------------------------------

### Install @loopback/boot with npm

Source: https://www.jsdocs.io/package/@loopback/boot

Install the @loopback/boot package using npm.

```bash
npm i @loopback/boot

```

--------------------------------

### Client.initWithMiddleware

Source: https://www.jsdocs.io/package/@microsoft/microsoft-graph-client

Initializes a new instance of the Client with provided Client Options.

```APIDOC
## method initWithMiddleware

### Description
To create a client instance with the Client Options.

### Parameters
#### Request Body
* **clientOptions** (ClientOptions) - Required - The options object for initializing the client

### Returns
The Client instance
```

--------------------------------

### Get Start Offset of Selection

Source: https://www.jsdocs.io/package/@types/draft-js

Retrieves the offset of the start point of the selection.

```typescript
getStartOffset: () => number;
```

--------------------------------

### Get Start Key of Selection

Source: https://www.jsdocs.io/package/@types/draft-js

Retrieves the key of the start point of the selection.

```typescript
getStartKey: () => string;
```

--------------------------------

### setup()

Source: https://www.jsdocs.io/package/@cycle/run

The setup() function prepares a Cycle.js application for execution without immediately running it. It takes a main function and drivers, returning an object containing sources, sinks, and a run function. The application is executed only when the returned run() function is called.

```APIDOC
## setup()

### Description
A function that prepares the Cycle application to be executed. Takes a `main` function and prepares to circularly connects it to the given collection of driver functions. As an output, `setup()` returns an object with three properties: `sources`, `sinks` and `run`. Only when `run()` is called will the application actually execute.

### Method
setup

### Parameters
#### main
a function that takes `sources` as input and outputs `sinks`.
#### drivers
an object where keys are driver names and values are driver functions.

### Returns
{Object} an object with three properties: `sources`, `sinks` and `run`. `sources` is the collection of driver sources, `sinks` is the collection of driver sinks, these can be used for debugging or testing. `run` is the function that once called will execute the application.

### Example
```javascript
import {setup} from '@cycle/run';
const {sources, sinks, run} = setup(main, drivers);
// ...
const dispose = run(); // Executes the application
// ...
dispose();
```
```

--------------------------------

### Get User Installation

Source: https://www.jsdocs.io/package/@octokit/types

Retrieves the GitHub App installation for a specific user.

```APIDOC
## GET /users/{username}/installation

### Description
Retrieves the GitHub App installation for a specific user.

### Method
GET

### Endpoint
/users/{username}/installation

### Parameters
#### Path Parameters
- **username** (string) - Required - The username of the user.
```

--------------------------------

### setup

Source: https://www.jsdocs.io/package/dnd-core

Initializes the drag and drop system. Should be called once at the application's entry point.

```APIDOC
## method setup

### Description
Sets up the drag and drop system.

### Signature
```typescript
setup: () => void;
```
```

--------------------------------

### setup

Source: https://www.jsdocs.io/package/@feathersjs/authentication

Sets up the strategy with the AuthenticationService and its name.

```APIDOC
## setup

### Description
Implement this method to setup this strategy.

### Method
`setup`

#### Parameters
* **auth** (AuthenticationBase) - The AuthenticationService.
* **name** (string) - The name of the strategy.

### Returns
A Promise that resolves when the setup is complete.
```

--------------------------------

### start Property

Source: https://www.jsdocs.io/package/slate

Gets the starting point of a range or location, omitting the first argument.

```typescript
start: OmitFirstArg<typeof Editor.start>;
```

--------------------------------

### Q.try Example

Source: https://www.jsdocs.io/package/@types/q

Demonstrates using Q.try to handle potential errors when syncing to the cloud, including checking connection status and logging errors.

```javascript
Q.try(function () { if (!isConnectedToCloud()) { throw new Error("The cloud is down!"); } return syncToCloud(); })
 .catch(function (error) { console.error("Couldn't sync to the cloud", error); });
```

--------------------------------

### Get Start of Week

Source: https://www.jsdocs.io/package/@types/luxon

Retrieves the weekday on which the week starts, according to the specified locale.

```javascript
Info.getStartOfWeek()
```

--------------------------------

### Get User Installations

Source: https://www.jsdocs.io/package/@octokit/types

Retrieves a list of GitHub App installations for the authenticated user.

```APIDOC
## GET /user/installations

### Description
Retrieves a list of GitHub App installations for the authenticated user.

### Method
GET

### Endpoint
/user/installations
```

--------------------------------

### Setup and Miscellaneous Methods

Source: https://www.jsdocs.io/package/ngx-color-picker

Methods for setting up the dialog with various configuration options and handling other specific events.

```APIDOC
## Setup and Miscellaneous Methods

### `onCancelColor(event: Event) => void;`
Handles the cancel color action.

### `onMouseDown(event: MouseEvent) => void;`
Handles mouse down events.

### `onRemovePresetColor(event: any, value: string) => void;`
Handles the removal of a preset color.

### `onResize() => void;`
Callback when the component is resized.

### `setupDialog(...) => void;`
Sets up the color picker dialog with a comprehensive set of configuration options, including element references, dimensions, display modes, color formats, and event handlers.
```

--------------------------------

### Example of running HTTP and HTTPS servers with Connect

Source: https://www.jsdocs.io/package/@types/connect

Demonstrates how to wrap Connect applications for both HTTP and HTTPS servers.

```javascript
var connect = require('connect') , http = require('http') , https = require('https');
var app = connect();
http.createServer(app).listen(80); https.createServer(options, app).listen(443);

```

--------------------------------

### Get Start Position of Range

Source: https://www.jsdocs.io/package/monaco-editor-core

Returns the start position of a given range. The start position is guaranteed to be before or equal to the end position.

```typescript
static getStartPosition: (range: IRange) => Position;
```

--------------------------------

### Get Installations Service

Source: https://www.jsdocs.io/package/firebase

Retrieves the Firebase Installations service for the current app. Note that the Installations SDK is not supported in Node.js environments.

```javascript
const installations = app.installations();
// The above is shorthand for:
// const installations = firebase.installations(app);
```

--------------------------------

### setup

Source: https://www.jsdocs.io/package/bs-logger

Sets up the logger, optionally providing a factory function to create the logger instance.

```APIDOC
## function setup

### Description
Sets up the logger, optionally providing a factory function to create the logger instance.

### Signature
```typescript
setup: (factory?: () => Logger) => void;
```
```

--------------------------------

### Tremolo Example: Create and Start

Source: https://www.jsdocs.io/package/tone

Creates a Tremolo effect, connects it to the destination, and starts its LFO. It then routes an oscillator through the tremolo and starts the oscillator.

```javascript
const tremolo = new Tone.Tremolo(9, 0.75).toDestination().start();
const oscillator = new Tone.Oscillator().connect(tremolo).start();
```

--------------------------------

### setup

Source: https://www.jsdocs.io/package/bs-logger

Sets up the logging environment, optionally with a specific log target mock.

```APIDOC
## function setup

### Description
Sets up the logging environment, optionally with a specific log target mock.

### Signature
```typescript
setup: (target?: LogTargetMock) => void;
```
```

--------------------------------

### Tone.FatOscillator Example

Source: https://www.jsdocs.io/package/tone

Example of creating and starting a FatOscillator with a specified frequency, type, and detune spread.

```javascript
const fatOsc = new Tone.FatOscillator("Ab3", "sawtooth", 40).toDestination().start();  Source
```

--------------------------------

### Prepare Method

Source: https://www.jsdocs.io/package/chrome-launcher

Performs necessary setup before launching Chrome.

```typescript
prepare: () => void;
```

--------------------------------

### Install @loopback/boot with yarn

Source: https://www.jsdocs.io/package/@loopback/boot

Install the @loopback/boot package using yarn.

```bash
yarn add @loopback/boot

```

--------------------------------

### Example: Get Default App Name

Source: https://www.jsdocs.io/package/firebase

Demonstrates how to get the name of the default Firebase app.

```javascript
// The default app's name is "[DEFAULT]"
firebase.initializeApp(defaultAppConfig);
console.log(firebase.app().name);  // "[DEFAULT]"

```

--------------------------------

### Tone.Envelope Example: getValueAtTime

Source: https://www.jsdocs.io/package/tone

Example demonstrating how to get the scheduled value of an envelope at a specific time.

```javascript
const env = new Tone.Envelope(0.5, 1, 0.4, 2); env.triggerAttackRelease(2); setInterval(() => console.log(env.getValueAtTime(Tone.now())), 100);
```

--------------------------------

### IMock.setup

Source: https://www.jsdocs.io/package/typemoq

Sets up a method or property on the mock.

```APIDOC
## IMock.setup

### Description
Sets up a method or property on the mock. This is where you define the behavior of mocked members.

### Method
setup

### Parameters
- **expression** (common.IFunc2<T, TResult>) - Required - An expression that identifies the method or property to set up.

### Returns
A MethodCallReturn object to configure the return value or behavior.
```

--------------------------------

### app.installations()

Source: https://www.jsdocs.io/package/firebase

Gets the Installations service for the current app. The Installations SDK does not work in a Node.js environment.

```APIDOC
## app.installations()

### Description
Gets the service for the current app. The Installations SDK does not work in a Node.js environment.

### Method
```javascript
installations: () => firebase.installations.Installations;
```

### Request Example
```javascript
const installations = app.installations();
// The above is shorthand for:
// const installations = firebase.installations(app);
```
```

--------------------------------

### setup

Source: https://www.jsdocs.io/package/antlr4ts

Protected method to set up the token stream.

```APIDOC
## method setup

### Description
Protected method to set up the token stream.

### Method Signature
`protected setup: () => void;`
```

--------------------------------

### Example: Get User by ID

Source: https://www.jsdocs.io/package/hn-ts

An example demonstrating how to fetch a user by their ID and log their properties.

```typescript
import { getUserById } from 'hn-ts';


(async () => {
  const user = await getUserById({
    id: "velut",
  });


  // Output: `velut`
  console.log(user.id);
})();

```

--------------------------------

### Create and Start a REST Server

Source: https://www.jsdocs.io/package/@loopback/rest

Demonstrates how to create a LoopBack application, add the RestComponent, retrieve the RestServer, create an HTTP server, and start listening on a port.

```typescript
const app = new Application();
app.component(RestComponent);
// setup controllers, etc.


const restServer = await app.getServer(RestServer);
const httpServer = http.createServer(restServer.requestHandler);
httpServer.listen(3000);
```

--------------------------------

### Setup Strategy Method

Source: https://www.jsdocs.io/package/@feathersjs/authentication

Initializes the strategy with the AuthenticationService and its name. Implement to perform strategy-specific setup.

```typescript
setup: (auth: AuthenticationBase, name: string) => Promise<void>;
```

--------------------------------

### Example: Get Item by ID

Source: https://www.jsdocs.io/package/hn-ts

An example demonstrating how to fetch an item by its ID and log its properties.

```typescript
import { getItemById } from 'hn-ts';


(async () => {
  const item = await getItemById({
    id: 27107832,
  });


  // Output: `27107832`
  console.log(item.id);


  // Output: `story`
  console.log(item.type);


  // Output: `velut`
  console.log(item.author);
})();

```

--------------------------------

### NgTscPlugin.setupCompilation

Source: https://www.jsdocs.io/package/@angular/compiler-cli

Sets up the compilation environment, returning sets of source files to ignore for diagnostics and emit.

```APIDOC
## method setupCompilation

### Description
Sets up the compilation environment, returning sets of source files to ignore for diagnostics and emit.

### Signature
```typescript
setupCompilation: (
    program: ts.Program,
    oldProgram?: ts.Program
) => {
    ignoreForDiagnostics: Set<ts.SourceFile>;
    ignoreForEmit: Set<ts.SourceFile>;
};
```
```

--------------------------------

### Get Node Example

Source: https://www.jsdocs.io/package/gatsby

Example demonstrating how to retrieve a node using its ID with the getNode function.

```javascript
const node = getNode(id)
```

--------------------------------

### Get Code Scanning Default Setup

Source: https://www.jsdocs.io/package/@octokit/types

Retrieves the default setup for code scanning in a repository.

```APIDOC
## GET /repos/{owner}/{repo}/code-scanning/default-setup

### Description
Retrieves the default setup for code scanning in a repository.

### Method
GET

### Endpoint
/repos/{owner}/{repo}/code-scanning/default-setup
```

--------------------------------

### AuthenticationService.setup

Source: https://www.jsdocs.io/package/@feathersjs/authentication

Performs setup tasks for the authentication service, likely involving strategy initialization.

```APIDOC
## setup

### Description
Sets up the authentication service.
```

--------------------------------

### Example: Creating a Story with Preview Meta

Source: https://www.jsdocs.io/package/@storybook/web-components

Demonstrates using `preview.meta()` to configure a component and `meta.story()` to create a primary story with arguments.

```javascript
const meta = preview.meta({ component: 'my-button' });
export const Primary = meta.story({ args: { label: 'Click me' } });
```

--------------------------------

### Get Install Dependencies

Source: https://www.jsdocs.io/package/@adonisjs/sink

Returns a list of dependencies to be installed, optionally filtered by development dependencies.

```typescript
getInstalls: (dev?: boolean) => Dependencies;
```

--------------------------------

### Mocha setup Method

Source: https://www.jsdocs.io/package/ts-helpers

Sets up Mocha with the provided options. Returns the Mocha instance for chaining.

```typescript
setup: (options: MochaSetupOptions) => Mocha;
```

--------------------------------

### Example: Get Named App Name

Source: https://www.jsdocs.io/package/firebase

Demonstrates how to get the name of a specifically initialized Firebase app.

```javascript
// A named app's name is what you provide to initializeApp()
var otherApp = firebase.initializeApp(otherAppConfig, "other");
console.log(otherApp.name);  // "other"

```

--------------------------------

### Example: Path Config for Static Navigation

Source: https://www.jsdocs.io/package/@react-navigation/core

Example demonstrating how to create a path configuration object using `createPathConfigForStaticNavigation` for nested screens.

```javascript
const config = {
  screens: {
    Home: {
      screens: createPathConfigForStaticNavigation(HomeTabs),
    },
  },
};
```

--------------------------------

### CommonNsisOptions

Source: https://www.jsdocs.io/package/app-builder-lib

Common options for NSIS installers, allowing customization of binaries, resources, GUID, and installer properties.

```APIDOC
## CommonNsisOptions

### Description
Provides common configuration options for NSIS installers.

### Properties
* **customNsisBinary** (CustomNsisBinary | null) - Optional - Allows providing a custom `makensis` binary, potentially with enhanced logging capabilities.
* **customNsisResources** (CustomNsisResources | null) - Optional - Allows providing custom `nsis-resources`.
* **guid** (string | null) - Optional - The GUID for the installer, used for upgrade and uninstall. If not specified, a GUID is generated from the `appId`. Changing `appId` after initial install will break silent upgrades.
* **unicode** (boolean) - Optional - Specifies whether to create a Unicode installer.
* **useZip** (boolean) - Optional - Forces the use of zip compression format instead of LZMA, primarily for differential update packages.
* **warningsAsErrors** (boolean) - Optional - Determines whether NSIS warnings are treated as errors. Defaults to `true`.
```

--------------------------------

### Install @instructure/ui-react-utils with yarn

Source: https://www.jsdocs.io/package/@instructure/ui-react-utils

Install the package using yarn.

```bash
yarn add @instructure/ui-react-utils
```

--------------------------------

### Install @instructure/ui-themeable with npm

Source: https://www.jsdocs.io/package/@instructure/ui-themeable

Use this command to install the package using npm.

```bash
npm i @instructure/ui-themeable
```

--------------------------------

### Get Start Position of CommentRange

Source: https://www.jsdocs.io/package/ts-simple-ast

Retrieves the starting position (index) of the comment range in the source file.

```typescript
getPos: () => number;
```

--------------------------------

### CompulsoryKeys Type Usage Example

Source: https://www.jsdocs.io/package/ts-toolbelt

Shows an example of using L.CompulsoryKeys to get the compulsory keys of a list.

```typescript
import {L} from 'ts-toolbelt'

type test0 = L.CompulsoryKeys<[1, 2, 3]> // {0: 1, 1: 2, 2: 3}

```

--------------------------------

### setupURI

Source: https://www.jsdocs.io/package/hap-nodejs

Sets up a URI for the accessory.

```APIDOC
## setupURI

### Description
Sets up a URI for the accessory.

### Method
setupURI

### Returns
- string: The setup URI.
```

--------------------------------

### Get Chrome Installation Path

Source: https://www.jsdocs.io/package/chrome-launcher

This function returns the default Chrome installation path that chrome-launcher will use.

```typescript
getChromePath: () => string;
```

--------------------------------

### Install @instructure/ui-react-utils with npm

Source: https://www.jsdocs.io/package/@instructure/ui-react-utils

Install the package using npm.

```bash
npm i @instructure/ui-react-utils
```

--------------------------------

### Get value from native injector (example)

Source: https://www.jsdocs.io/package/@uirouter/core

Example of retrieving a value using getNative with a specific token.

```javascript
let someThing = injector.getNative(SomeToken);
```

--------------------------------

### Install @instructure/ui-test-utils with yarn

Source: https://www.jsdocs.io/package/@instructure/ui-test-utils

Install the package using yarn.

```bash
yarn add @instructure/ui-test-utils
```

--------------------------------

### SystemManager.setup

Source: https://www.jsdocs.io/package/@pixi/core

Set up a system with a collection of SystemClasses and runners. Systems are attached dynamically to this class when added.

```APIDOC
### method setup

### Description
Set up a system with a collection of SystemClasses and runners. Systems are attached dynamically to this class when added.

### Signature
```typescript
setup(config: ISystemConfig<R>): void
```

### Parameters
#### Parameter config
the config for the system manager
```

--------------------------------

### Get Old File Start Line

Source: https://www.jsdocs.io/package/@types/nodegit

Returns the starting line number for old content in the file.

```typescript
oldStart: () => number;
```

--------------------------------

### setUpTests

Source: https://www.jsdocs.io/package/react-native-reanimated

Initializes testing environment with optional user framerate configuration.

```APIDOC
## function setUpTests

```
setUpTests: (userFramerateConfig?: {}) => void;
```

### Description

Initializes the testing environment. Optionally accepts a user framerate configuration.

#### Parameters

*   **userFramerateConfig** ({}) - Optional - Configuration for user framerate.
```

--------------------------------

### Get New File Start Line

Source: https://www.jsdocs.io/package/@types/nodegit

Returns the starting line number for new content in the file.

```typescript
newStart: () => number;
```

--------------------------------

### SasTokenProperties Start Time Property

Source: https://www.jsdocs.io/package/@azure/cosmos

Gets or sets the start time of the SAS token's validity.

```typescript
startTime: Date;
```

--------------------------------

### IKernelAPIClient.startNew

Source: https://www.jsdocs.io/package/@jupyterlab/services

Starts a new kernel session with optional configuration.

```APIDOC
## method startNew

### Description
Start a new kernel.

### Method Signature
```typescript
startNew: (options?: IKernelOptions) => Promise<IModel>;
```

### Parameters
* **options** (IKernelOptions, optional) - The options used to create the kernel.

### Returns
A promise that resolves with the new kernel model.
```

--------------------------------

### Get Arrow Start Head

Source: https://www.jsdocs.io/package/@antv/g

Retrieves the display object representing the arrow's start head.

```typescript
getStartHead: () => DisplayObject<any, any>;
```

--------------------------------

### Launch Browser and Create Page Example

Source: https://www.jsdocs.io/package/puppeteer-core

Launches a browser instance and creates a new page to navigate to a URL.

```javascript
import puppeteer from 'puppeteer';


const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.goto('https://example.com');
await browser.close();
```

--------------------------------

### Get Environment Template Installation for Environment

Source: https://www.jsdocs.io/package/contentful-management

Fetches environment template installations for a specific environment, with options for filtering by installation ID. Supports cursor-based pagination.

```typescript
environmentTemplateInstallation.getForEnvironment(
    params: BasicCursorPaginationOptions &
        EnvironmentTemplateParams & {
            installationId?: string;
        },
    headers?: RawAxiosRequestHeaders
): Promise<
    CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>
>;
```

--------------------------------

### Install @loopback/boot with pnpm

Source: https://www.jsdocs.io/package/@loopback/boot

Install the @loopback/boot package using pnpm.

```bash
pnpm add @loopback/boot

```

--------------------------------

### Installation

Source: https://www.jsdocs.io/package/web-streams-polyfill

Instructions for installing the web-streams-polyfill library using various package managers.

```APIDOC
## Install

```bash
npm i web-streams-polyfill
```

```bash
yarn add web-streams-polyfill
```

```bash
pnpm add web-streams-polyfill
```
```

--------------------------------

### Get Firebase Installations Auth Token

Source: https://www.jsdocs.io/package/@firebase/installations

Returns a Firebase Installations auth token, identifying the current Firebase Installation. Optionally force refresh the token.

```typescript
getToken: (
    installations: Installations,
    forceRefresh?: boolean
) => Promise<string>;
```

--------------------------------

### Example Tokens for Encoding

Source: https://www.jsdocs.io/package/@types/vscode

An example of three tokens with their line, start character, length, type, and modifiers before encoding.

```javascript
{ line: 2, startChar:  5, length: 3, tokenType: "property",  tokenModifiers: ["private", "static"] },
   { line: 2, startChar: 10, length: 4, tokenType: "type",      tokenModifiers: [] },
   { line: 5, startChar:  2, length: 7, tokenType: "class",     tokenModifiers: [] }
```

--------------------------------

### setup

Source: https://www.jsdocs.io/package/@azure/functions

An optional method to configure the behavior of your app during startup. It can be called multiple times, and options will be merged.

```APIDOC
## function setup

### Description
Optional method to configure the behavior of your app. This can only be done during app startup, before invocations occur. If called multiple times, options will be merged with the previous options specified.

### Parameters
#### Path Parameters
- **options** (SetupOptions) - Required - Configuration options for the app setup.
```

--------------------------------

### Web OAuth Server Usage Example

Source: https://www.jsdocs.io/package/@salesforce/core

Example demonstrating how to create, start, and use the WebOAuthServer for login flows.

```typescript
const oauthConfig = {
  loginUrl: this.flags.instanceurl,
  clientId: this.flags.clientid,
};


const oauthServer = await WebOAuthServer.create({ oauthConfig });
await oauthServer.start();
await open(oauthServer.getAuthorizationUrl(), { wait: false });
const authInfo = await oauthServer.authorizeAndSave();
```

--------------------------------

### Install @instructure/ui-babel-preset with npm

Source: https://www.jsdocs.io/package/@instructure/ui-babel-preset

Use this command to install the package using npm.

```bash
npm i @instructure/ui-babel-preset
```

--------------------------------

### Get or Set Event Example

Source: https://www.jsdocs.io/package/tone

Demonstrates getting and setting event values at specific times within a Part.

```javascript
const part = new Tone.Part(); part.at("1m"); // returns the part at the first measure part.at("2m", "C2"); // set the value at "2m" to C2.
// if an event didn't exist at that time, it will be created.
```

--------------------------------

### Setup EXE Property

Source: https://www.jsdocs.io/package/electron-winstaller

Specifies the filename for the generated Setup.exe file.

```typescript
setupExe?: string;
```

--------------------------------

### startNew

Source: https://www.jsdocs.io/package/@jupyterlab/services

Start a new kernel. This method is not supported and will throw an error.

```APIDOC
## method startNew

### Description
Start a new kernel. This method is not supported and will throw an error.

### Signature
```typescript
startNew: (createOptions?: IKernelOptions, connectOptions?: Omit<Kernel.IKernelConnection.IOptions, 'model' | 'serverSettings'>) => Promise<Kernel.IKernelConnection>;
```
```

--------------------------------

### Get Non-Whitespace Start Position

Source: https://www.jsdocs.io/package/ts-simple-ast

Finds the starting position of the first non-whitespace character in the source file text.

```typescript
getNonWhitespaceStart: () => number;
```

--------------------------------

### Install @instructure/ui-test-utils with npm

Source: https://www.jsdocs.io/package/@instructure/ui-test-utils

Install the package using npm.

```bash
npm i @instructure/ui-test-utils
```

--------------------------------

### Get Install Referrer Sync

Source: https://www.jsdocs.io/package/react-native-device-info

Synchronously retrieves the install referrer information. Compatible with Android, Windows, and Web.

```typescript
const getInstallReferrerSync: Getter<string>;
```

```typescript
const result = getInstallReferrerSync();
```

--------------------------------

### StartupSystem Methods

Source: https://www.jsdocs.io/package/@pixi/core

Manages the initialization and startup sequence of PixiJS systems.

```APIDOC
## StartupSystem Class

### Description
Manages the startup process of PixiJS systems.

### Methods

#### `StartupSystem.run()`
Executes the startup sequence.

#### `StartupSystem.destroy()`
Destroys the startup system.

### Properties

*   **renderer** (Renderer): The PixiJS renderer instance.
*   **defaultOptions** (object): Default options for startup.
*   **extension** (object): Extension properties.
```

--------------------------------

### Get First Install Time (Sync)

Source: https://www.jsdocs.io/package/react-native-device-info

Retrieves the first install time of the application synchronously. Not available on Web.

```javascript
const getFirstInstallTimeSync: Getter<number>;
```

```javascript
const result = getFirstInstallTimeSync();
```

--------------------------------

### Get First Install Time (Async)

Source: https://www.jsdocs.io/package/react-native-device-info

Retrieves the first install time of the application asynchronously. Not available on Web.

```javascript
const getFirstInstallTime: Getter<Promise<number>>;
```

```javascript
const result = await getFirstInstallTime();
```

--------------------------------

### Install @instructure/ui-themeable with yarn

Source: https://www.jsdocs.io/package/@instructure/ui-themeable

Use this command to install the package using yarn.

```bash
yarn add @instructure/ui-themeable
```

--------------------------------

### Install App Method

Source: https://www.jsdocs.io/package/webdriver-js-extender

Installs an application on the device from a given path.

```typescript
installApp: (appPath: string) => wdpromise.Promise<void>;
```

--------------------------------

### Example: Setting up an On Get Handler

Source: https://www.jsdocs.io/package/hap-nodejs

An example demonstrating how to set up an 'onGet' handler for a Characteristic, returning a boolean value.

```typescript
Characteristic.onGet(async () => {
  return true;
});
```

--------------------------------

### setupReusable()

Source: https://www.jsdocs.io/package/@cycle/run

The setupReusable() function allows for the reuse of a set of drivers across multiple main functions. It takes drivers as input and returns an object with sources and a run function. This run function can be invoked multiple times with different main functions, reusing the initial drivers.

```APIDOC
## setupReusable()

### Description
A partially-applied variant of setup() which accepts only the drivers, and allows many `main` functions to execute and reuse this same set of drivers.

### Method
setupReusable

### Parameters
#### drivers
an object where keys are driver names and values are driver functions.

### Returns
{Object} an object with three properties: `sources`, `run` and `dispose`. `sources` is the collection of driver sources, `run` is the function that once called with 'sinks' as argument, will execute the application, tying together sources with sinks. `dispose` terminates the reusable resources used by the drivers. Note also that `run` returns a dispose function which terminates resources that are specific (not reusable) to that run.

### Example
```javascript
import {setupReusable} from '@cycle/run';
const {sources, run, dispose} = setupReusable(drivers);
// ...
const sinks = main(sources);
const disposeRun = run(sinks);
// ...
disposeRun();
// ...
dispose(); // ends the reusability of drivers
```
```

--------------------------------

### Get Environment Mode

Source: https://www.jsdocs.io/package/@salesforce/core

Gets the current environment mode as a Mode instance. Example shows checking if the mode is PRODUCTION.

```typescript
static getEnvironmentMode: () => Mode;
```

```javascript
console.log(Global.getEnvironmentMode() === Mode.PRODUCTION);
```

--------------------------------

### Define Guid Options Interface in Joi

Source: https://www.jsdocs.io/package/joi

An empty interface representing options for GUID validation. No specific setup is required.

```typescript
interface GuidOptions {}
```

--------------------------------

### Create User Example

Source: https://www.jsdocs.io/package/@salesforce/core

Example demonstrating how to create a new user using default fields.

```typescript
const connection: Connection = await Connection.create({
  authInfo: await AuthInfo.create({ username: 'user@example.com' })
});
const org = await Org.create({ connection });


const defaultUserFields = await DefaultUserFields.create({ templateUser: 'devhub_user@example.com' });
const user: User = await User.create({ org });
const info: AuthInfo = await user.createUser(defaultUserFields.getFields());
```

--------------------------------

### Install with npm

Source: https://www.jsdocs.io/package/@size-limit/preset-small-lib

Install the @size-limit/preset-small-lib package using npm.

```bash
npm i @size-limit/preset-small-lib
```

--------------------------------

### Get Install Referrer

Source: https://www.jsdocs.io/package/react-native-device-info

Asynchronously retrieves the install referrer information from the native platform. Compatible with Android, Windows, and Web.

```typescript
const getInstallReferrer: Getter<Promise<string>>;
```

```typescript
const result = await getInstallReferrer();
```

--------------------------------

### SetupContext Interface

Source: https://www.jsdocs.io/package/@vue/composition-api

Provides context to the component's setup function.

```APIDOC
## Interface: SetupContext<E>

### Description
Provides context to the component's setup function.

### Properties

- **attrs** (Data) - The attributes passed to the component.
- **emit** (EmitFn<E>) - Function to emit events from the component.
- **expose** (exposed?: Record<string, any>) => void - Exposes properties to be accessed from the outside. Deprecated: not available in Vue 2.
- **listeners** (Record<string, Function> | undefined) - Listeners for events. Deprecated: not available in Vue 3.
- **parent** (ComponentInstance | null) - The parent component instance. Deprecated: not available in Vue 3.
- **refs** (Record<string, Vue | Element | Vue[] | Element[]>) - References to child components or DOM elements. Deprecated: not available in Vue 3.
- **root** (ComponentInstance) - The root component instance. Deprecated: not available in Vue 3.
- **slots** (Slots) - The slots passed to the component.
```

--------------------------------

### Example: Get Max Item ID

Source: https://www.jsdocs.io/package/hn-ts

An example demonstrating how to fetch the maximum item ID from the Hacker News API.

```typescript
import { getMaxItemId } from 'hn-ts';


(async () => {
  const id = await getMaxItemId();


  // Output: a number like `27107832`
  console.log(id);
})();

```

--------------------------------

### setup

Source: https://www.jsdocs.io/package/@nebular/auth

Sets up the OAuth2 authentication strategy with given options.

```APIDOC
## method setup

### Description
Sets up the OAuth2 authentication strategy with given options.

### Method Signature
static setup: (
    options: NbOAuth2AuthStrategyOptions
) => [NbAuthStrategyClass, NbOAuth2AuthStrategyOptions]
```

--------------------------------

### Query document with CSS selector example

Source: https://www.jsdocs.io/package/angular2

Example of using the $ shortcut to find an element by CSS selector and get its text.

```javascript
var item = $('.count .two'); expect(item.getText()).toBe('Second');
```

--------------------------------

### GET /app/installation-requests

Source: https://www.jsdocs.io/package/@octokit/types

Lists pending installation requests for the GitHub App. This endpoint shows requests from organizations to install the app.

```APIDOC
## GET /app/installation-requests

### Description
Lists pending installation requests for the GitHub App.

### Method
GET

### Endpoint
/app/installation-requests
```
Tokens:
Raw