ngx-uploader
- Version 17.0.1
- Published
- 144 kB
- 1 dependency
- MIT license
Install
npm i ngx-uploader
yarn add ngx-uploader
pnpm add ngx-uploader
Overview
Angular 2+ File Uploader
Index
Functions
Classes
Interfaces
Enums
Functions
function humanizeBytes
humanizeBytes: (bytes: number) => string;
Classes
class NgFileDropDirective
class NgFileDropDirective implements OnInit, OnDestroy {}
constructor
constructor(elementRef: ElementRef);
property el
el: HTMLInputElement;
property elementRef
elementRef: ElementRef;
property options
options: UploaderOptions;
property ɵdir
static ɵdir: i0.ɵɵDirectiveDeclaration< NgFileDropDirective, '[ngFileDrop]', never, { options: { alias: 'options'; required: false }; uploadInput: { alias: 'uploadInput'; required: false }; }, { uploadOutput: 'uploadOutput' }, never, never, false, never>;
property ɵfac
static ɵfac: i0.ɵɵFactoryDeclaration<NgFileDropDirective, never>;
property stopEvent
stopEvent: (e: Event) => void;
property upload
upload: NgUploaderService;
property uploadInput
uploadInput: EventEmitter<UploadInput>;
property uploadOutput
uploadOutput: EventEmitter<UploadOutput>;
method ngOnDestroy
ngOnDestroy: () => void;
method ngOnInit
ngOnInit: () => void;
method onDragLeave
onDragLeave: (e: Event) => void;
method onDragOver
onDragOver: (e: Event) => void;
method onDrop
onDrop: (e: any) => void;
class NgFileSelectDirective
class NgFileSelectDirective implements OnInit, OnDestroy {}
constructor
constructor(elementRef: ElementRef);
property el
el: HTMLInputElement;
property elementRef
elementRef: ElementRef;
property fileListener
fileListener: () => void;
property options
options: UploaderOptions;
property ɵdir
static ɵdir: i0.ɵɵDirectiveDeclaration< NgFileSelectDirective, '[ngFileSelect]', never, { options: { alias: 'options'; required: false }; uploadInput: { alias: 'uploadInput'; required: false }; }, { uploadOutput: 'uploadOutput' }, never, never, false, never>;
property ɵfac
static ɵfac: i0.ɵɵFactoryDeclaration<NgFileSelectDirective, never>;
property upload
upload: NgUploaderService;
property uploadInput
uploadInput: EventEmitter<any>;
property uploadOutput
uploadOutput: EventEmitter<UploadOutput>;
method ngOnDestroy
ngOnDestroy: () => void;
method ngOnInit
ngOnInit: () => void;
class NgUploaderService
class NgUploaderService {}
constructor
constructor( concurrency?: number, contentTypes?: string[], maxUploads?: number, maxFileSize?: number);
property contentTypes
contentTypes: string[];
property maxFileSize
maxFileSize: number;
property maxUploads
maxUploads: number;
property queue
queue: UploadFile[];
property serviceEvents
serviceEvents: EventEmitter<UploadOutput>;
property subs
subs: { id: string; sub: Subscription }[];
property uploadScheduler
uploadScheduler: Subject<{ file: UploadFile; event: UploadInput }>;
method allContentTypesAllowed
allContentTypesAllowed: () => boolean;
method generateId
generateId: () => string;
method handleFiles
handleFiles: (incomingFiles: FileList) => void;
method initInputEvents
initInputEvents: (input: EventEmitter<UploadInput>) => Subscription;
method isContentTypeAllowed
isContentTypeAllowed: (mimetype: string) => boolean;
method isFileSizeAllowed
isFileSizeAllowed: (fileSize: number) => boolean;
method makeUploadFile
makeUploadFile: (file: File, index: number) => UploadFile;
method secondsToHuman
secondsToHuman: (sec: number) => string;
method setContentTypes
setContentTypes: (contentTypes: string[]) => void;
method startUpload
startUpload: (upload: { file: UploadFile; event: UploadInput;}) => Observable<UploadOutput>;
method uploadFile
uploadFile: (file: UploadFile, event: UploadInput) => Observable<UploadOutput>;
class NgxUploaderModule
class NgxUploaderModule {}
property ɵfac
static ɵfac: i0.ɵɵFactoryDeclaration<NgxUploaderModule, never>;
property ɵinj
static ɵinj: i0.ɵɵInjectorDeclaration<NgxUploaderModule>;
property ɵmod
static ɵmod: i0.ɵɵNgModuleDeclaration< NgxUploaderModule, [typeof i1.NgFileDropDirective, typeof i2.NgFileSelectDirective], never, [typeof i1.NgFileDropDirective, typeof i2.NgFileSelectDirective]>;
Interfaces
interface UploaderOptions
interface UploaderOptions {}
property allowedContentTypes
allowedContentTypes?: string[];
property concurrency
concurrency: number;
property maxFileSize
maxFileSize?: number;
property maxUploads
maxUploads?: number;
interface UploadFile
interface UploadFile {}
property fileIndex
fileIndex: number;
property form
form: FormData;
property id
id: string;
property lastModifiedDate
lastModifiedDate: Date;
property name
name: string;
property nativeFile
nativeFile?: File;
property progress
progress: UploadProgress;
property response
response?: any;
property responseHeaders
responseHeaders?: { [key: string]: string;};
property responseStatus
responseStatus?: number;
property size
size: number;
property sub
sub?: Subscription | any;
property type
type: string;
interface UploadInput
interface UploadInput {}
property data
data?: { [key: string]: string | Blob;};
property fieldName
fieldName?: string;
property file
file?: UploadFile;
property fileIndex
fileIndex?: number;
property headers
headers?: { [key: string]: string;};
property id
id?: string;
property includeWebKitFormBoundary
includeWebKitFormBoundary?: boolean;
property method
method?: string;
property type
type: | 'uploadAll' | 'uploadFile' | 'cancel' | 'cancelAll' | 'remove' | 'removeAll';
property url
url?: string;
property withCredentials
withCredentials?: boolean;
interface UploadOutput
interface UploadOutput {}
property file
file?: UploadFile;
property nativeFile
nativeFile?: File;
property type
type: | 'addedToQueue' | 'allAddedToQueue' | 'uploading' | 'done' | 'start' | 'cancelled' | 'dragOver' | 'dragOut' | 'drop' | 'removed' | 'removedAll' | 'rejected';
interface UploadProgress
interface UploadProgress {}
Enums
enum UploadStatus
enum UploadStatus { Queue = 0, Uploading = 1, Done = 2, Cancelled = 3,}
Package Files (6)
Dependencies (1)
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (2)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/ngx-uploader
.
- Markdown[](https://www.jsdocs.io/package/ngx-uploader)
- HTML<a href="https://www.jsdocs.io/package/ngx-uploader"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3400 ms. - Missing or incorrect documentation? Open an issue for this package.