## API Report File for "@aws-amplify/amplify-opensearch-simulator"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

/// <reference types="node" />

import { $TSAny } from '@aws-amplify/amplify-cli-core';
import execa from 'execa';
import { GetPackageAssetPaths } from '@aws-amplify/amplify-cli-core';

// Warning: (ae-forgotten-export) The symbol "OpenSearchEmulatorOptions" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export const buildArgs: (options: OpenSearchEmulatorOptions, pathToOpenSearchData: string) => string[];

// @public (undocumented)
export const ensureOpenSearchLocalExists: (pathToOpenSearchData: string) => Promise<void>;

// @public (undocumented)
export const exitingEmulatorPromise: (proc: execa.ExecaChildProcess<string>, prematureExit: $TSAny) => Promise<unknown>;

// @public (undocumented)
export const getOpensearchLocalDirectory: () => string;

// @public (undocumented)
export const getPackageAssetPaths: GetPackageAssetPaths;

// @public (undocumented)
export const getPathToOpenSearchBinary: (pathToOpenSearchLocal?: string) => Promise<string>;

// @public (undocumented)
export const launch: (pathToOpenSearchData: string, givenOptions?: OpenSearchEmulatorOptions, retry?: number, startTime?: number) => Promise<OpenSearchEmulator>;

// @public (undocumented)
export class OpenSearchEmulator {
    constructor(proc: execa.ExecaChildProcess<string>, opts: OpenSearchEmulatorOptions);
    // (undocumented)
    opts: OpenSearchEmulatorOptions;
    // (undocumented)
    get pid(): number | undefined;
    // (undocumented)
    get port(): number | undefined;
    // (undocumented)
    proc: execa.ExecaChildProcess<string>;
    // (undocumented)
    terminate(): Promise<void>;
    // (undocumented)
    get url(): string;
}

// @public (undocumented)
export const openSearchLocalExists: (pathToOpenSearchLocal: string) => Promise<boolean>;

// @public (undocumented)
export const packageName = "@aws-amplify/amplify-opensearch-simulator";

// @public (undocumented)
export const relativePathToOpensearchLocal: string;

// @public (undocumented)
export const startingEmulatorPromise: (opts: Required<OpenSearchEmulatorOptions>, proc: execa.ExecaChildProcess<string>, port: number) => Promise<unknown>;

// @public (undocumented)
export const startOpensearchEmulator: (opts: Required<OpenSearchEmulatorOptions>, proc: execa.ExecaChildProcess<string>, port: number, startTime: number, givenOptions: OpenSearchEmulatorOptions, pathToOpenSearchData: string, retry: number) => Promise<OpenSearchEmulator | undefined>;

// @public (undocumented)
export const supportedOpenSearchVersion = "1.3.0";

// @public (undocumented)
export const unzipOpensearchBuildFile: (opensearchSimulatorGunZippedTarball: Buffer, pathToOpenSearchLib: string) => Promise<void>;

// @public (undocumented)
export const writeOpensearchEmulatorArtifacts: (pathToOpenSearchLocal: string, opensearchSimulatorGunZippedTarball: $TSAny, latestSig: $TSAny, latestPublicKey: $TSAny) => Promise<void>;

// (No @packageDocumentation comment for this package)

```