Class AnalysesManager

This Manager is responsible for fetching and caching Analyses results.

Hierarchy

CachedManager<String, Analysis>
- AnalysesManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AnalysesManager(client: Client): AnalysesManager

Overrides CachedManager.constructor
- Defined in lib/AnalysesManager.ts:122
Parameters
- client: Client
Returns AnalysesManager

Properties

cache

cache: Map<String, Analysis>

This manager's cache.

client

client: Client

This Manager's Client

Methods

do

do(file: FileResolvable, options: AnalyzeOptions): Promise<Analysis>

- Defined in lib/AnalysesManager.ts:24
Submits a file to be analyzed.

Parameters
- file: FileResolvable
  
  The file to analyze
- options: AnalyzeOptions
Returns Promise<Analysis>

fetch

fetch(id: string, options?: FetchOptions): Promise<Analysis>

- Defined in lib/AnalysesManager.ts:44
Fetch an Analysis from the API and cache it.

Parameters
- id: string
  
  The analysis ID.
- Optional options: FetchOptions
Returns Promise<Analysis>

fetchFile

fetchFile(hash: string, options?: FetchOptions): Promise<Analysis>

- Defined in lib/AnalysesManager.ts:68
Fetch an Analysis from the API and cache it using the file's SHA256/SHA1/MD5 Hash.

Parameters
- hash: string
  
  The file's SHA256/SHA1/MD5 Hash.
- Optional options: FetchOptions
Returns Promise<Analysis>

get

get(id: string, options?: GetOptions): Promise<Analysis>

- Defined in lib/AnalysesManager.ts:93
Get an analysis either from the cache or by fetching it. It is recommended for performance reasons to use this method instead of .fetch().

Parameters
- id: string
  
  The analysis ID.
- Optional options: GetOptions
Returns Promise<Analysis>

getFile

getFile(hash: string, options?: GetOptions): Promise<Analysis>

- Defined in lib/AnalysesManager.ts:106
Get an analysis either from the cache or by fetching it using the file's SHA256/SHA1/MD5 Hash. It is recommended for performance reasons to use this method instead of .fetchFile().

Parameters
- hash: string
  
  The file's SHA256/SHA1/MD5 Hash.
- Optional options: GetOptions
Returns Promise<Analysis>

resolve

resolve(analysis: AnalysisResolvable, options?: GetOptions): Promise<Analysis>

- Defined in lib/AnalysesManager.ts:116
Resolves an AnalysisResolvable into an Analysis.

Parameters
- analysis: AnalysisResolvable
- Optional options: GetOptions
Returns Promise<Analysis>

Generated using TypeDoc