UNPKG

@nexim/upload-sdk

Version:

TypeScript SDK for seamless integration with Nexim Media Upload Service. It provides state machine-based upload handling, progress tracking, and type-safe API for image optimization and file uploads.

github.com/the-nexim/upload-kit/tree/next/packages/sdk

the-nexim/upload-kit

24 lines (17 loc) • 3.23 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# @nexim/upload-sdk ## Classes | Class | Description | | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [UploadFileMachine](classes/UploadFileMachine.md) | A state machine for managing file uploads. Handles file upload lifecycle including state management, API requests, and error handling. | | [UploadImageMachine](classes/UploadImageMachine.md) | Specialized state machine for handling image uploads. Extends UploadFileMachine with image-specific functionality including: - Image resizing based on preset configurations - Client-side image optimization - Automatic format conversion | ## Type Aliases | Type Alias | Description | | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | [UploadFileMachineOptions](type-aliases/UploadFileMachineOptions.md) | Configuration options for initializing an UploadFileMachine instance. | | [UploadFileMachineState](type-aliases/UploadFileMachineState.md) | - | | [UploadImageMachineOptions](type-aliases/UploadImageMachineOptions.md) | Configuration options for initializing an UploadImageMachine instance. Extends UploadFileMachineOptions with image-specific options. | | [UploadImageMachineState](type-aliases/UploadImageMachineState.md) | States for the image upload machine. Inherits all states from UploadFileMachineState. | ## Functions | Function | Description | | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [pickAndProcessFile](functions/pickAndProcessFile.md) | Creates and triggers a virtual file input element to handle file selection. This utility creates a temporary file input element, attaches event handlers, and removes itself after use. |