generated from tinovyatkin/typescript-repo-template
-
Notifications
You must be signed in to change notification settings - Fork 23
/
puppeteer-options.interface.ts
54 lines (45 loc) · 1.59 KB
/
puppeteer-options.interface.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
import { ModuleMetadata, Type } from '@nestjs/common/interfaces';
import type { LaunchOptions } from 'puppeteer';
/**
* Options that ultimately need to be provided to create a Puppeteer instance
*/
export interface PuppeteerModuleOptions {
instanceName?: string;
launchOptions?: LaunchOptions;
}
export interface PuppeteerOptionsFactory {
createPuppeteerOptions():
| Promise<PuppeteerModuleOptions>
| PuppeteerModuleOptions;
}
/**
* Options available when creating the module asynchronously. You should use only one of the
* useExisting, useClass, or useFactory options for creation.
*/
export interface PuppeteerModuleAsyncOptions
extends Pick<ModuleMetadata, 'imports'> {
/** A unique name for the instance. If not specified, a default one will be used. */
instanceName?: string;
/**
* If "true", registers `PuppeteerModule` as a global module.
* See: https://docs.nestjs.com/modules#global-modules
*/
isGlobal?: boolean;
/** Reuse an injectable factory class created in another module. */
useExisting?: Type<PuppeteerOptionsFactory>;
/**
* Use an injectable factory class to populate the module options, such as URI and database name.
*/
useClass?: Type<PuppeteerOptionsFactory>;
/**
* A factory function that will populate the module options, such as URI and database name.
*/
useFactory?: (
...args: any[]
) => Promise<PuppeteerModuleOptions> | PuppeteerModuleOptions;
/**
* Inject any dependencies required by the Puppeteer module, such as a configuration service
* that supplies the options and instance name
*/
inject?: any[];
}