@nest-boot/file-upload

Classes

FileUploadModule

Defined in: packages/file-upload/src/file-upload.module.ts:11

Extends

• ConfigurableModuleClass

Indexable

[key: string]: any

Constructors

Constructor

new FileUploadModule(): FileUploadModule;

Defined in: node_modules/.pnpm/@nestjs+common@11.1.9/node_modules/@nestjs/common/module-utils/interfaces/configurable-module-cls.interface.d.ts:12

Returns

FileUploadModule

Inherited from

ConfigurableModuleClass.constructor

Properties

register()

static register: (options) => DynamicModule;

Parameters

Parameter	Type
options	FileUploadModuleOptions & Partial<{ isGlobal: boolean; }>

Returns

DynamicModule

Inherited from

ConfigurableModuleClass.register

registerAsync()

static registerAsync: (options) => DynamicModule;

Parameters

Parameter	Type
options	ConfigurableModuleAsyncOptions<FileUploadModuleOptions, "create"> & Partial<{ isGlobal: boolean; }>

Returns

DynamicModule

Inherited from

ConfigurableModuleClass.registerAsync

---

FileUploadService

Defined in: packages/file-upload/src/file-upload.service.ts:21

Constructors

Constructor

new FileUploadService(options): FileUploadService;

Defined in: packages/file-upload/src/file-upload.service.ts:24

Parameters

Parameter	Type
options	FileUploadModuleOptions

Returns

FileUploadService

Methods

create()

create(input): Promise<FileUpload[]>;

Defined in: packages/file-upload/src/file-upload.service.ts:34

Parameters

Parameter	Type
input	FileUploadInput[]

Returns

Promise<FileUpload[]>

persist()

persist(tmpUrl): Promise<string>;

Defined in: packages/file-upload/src/file-upload.service.ts:94

Parameters

Parameter	Type
tmpUrl	string

Returns

Promise<string>

upload()

upload(
   data, 
   metadata, 
persist): Promise<string>;

Defined in: packages/file-upload/src/file-upload.service.ts:111

Parameters

Parameter	Type
data	string | Readable | Buffer<ArrayBufferLike>
metadata	{ [key: string]: any; Content-Type: string; extension?: string; }
metadata.Content-Type	string
metadata.extension?	string
persist	boolean

Returns

Promise<string>