Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ahkohd/thumbo
High-performance thumbnail library for browsers. Built with Rust 🦀 and WebAssembly 🕸
https://github.com/ahkohd/thumbo
image rust thumbnail video wasm wasm-pack webassembly
Last synced: 3 months ago
JSON representation
High-performance thumbnail library for browsers. Built with Rust 🦀 and WebAssembly 🕸
- Host: GitHub
- URL: https://github.com/ahkohd/thumbo
- Owner: ahkohd
- Created: 2021-10-25T01:39:35.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-15T20:30:20.000Z (4 months ago)
- Last Synced: 2024-10-19T13:38:49.267Z (4 months ago)
- Topics: image, rust, thumbnail, video, wasm, wasm-pack, webassembly
- Language: JavaScript
- Homepage: https://thumbo.netlify.app
- Size: 26.1 MB
- Stars: 18
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
thumbo
A high-performant thumbnail creation library
[](https://github.com/ahkohd/thumbo-core/actions/workflows/build.yml)
Built with Rust 🦀 & WebAssembly 🕸
## ✅ Features
- High-performance
- Web worker pool
- Built with Rust & Web Assembly
- Uses transferable objects
- Easy to use APIs
- Supports `Png`, `Jpeg`, `Gif`, `Ico` and `Svg`
## 🚴 Usage
Install the package from npm:
```bash
yarn add thumbo
```
```ts
import Thumbo, { Transfer } from "thumbo";
Thumbo.init().then(async () => {
Thumbo.thumbnail(
Transfer(await (await fetch("/path/to/img.png")).arrayBuffer()),
Thumbo.ImageFormat.Png,
20,
20
).then((thumbnailBuffer) => {
document.getElementById("img1").src = URL.createObjectURL(
new Blob([thumbnailBuffer])
);
});
Thumbo.thumbnailFromUrl(
"https://example.com/image.png",
Thumbo.ImageFormat.Png,
20,
20
).then((thumbnailBuffer) => {
document.getElementById("img2").src = URL.createObjectURL(
new Blob([thumbnailBuffer])
);
});
});
```
## ⚙️ API Reference
### Thumbo.init(config: [InitOptions](#initoptions)): Promise\
Initiates thumbo. The initiation proccess includes:
- Downloads the [thumbo-core](https://github.com/ahkohd/thumbo-core) WebAssembly bundle from [unpkg.com](https://unpkg.com/thumbo-core/pkg/thumbo_core_bg.wasm)
- Complies the WASM binary
- Starts a pool of web workers(8 workers are pooled by default, however, you can control the number of wokers to be spawned) to take thumbnail creation tasks
- After the afore mentioned steps are completed, `isInitialized` field is set `true`.
#### InitOptions
`InitOptions` interface provides the configuration for the `init` method.
```ts
interface InitOptions {
/** Url to fetch the thumbo-core WASM bundle. Defaults to the bundle hosted on unpkg. */
wasmUrl?: string;
/** Maximum no. of tasks to run on one worker thread at a time. Defaults to one. */
concurrency?: number;
/** Maximum no. of jobs to be queued for execution before throwing an error. */
maxQueuedJobs?: number;
/** Gives that pool a name to be used for debug logging, letting you distinguish between log output of different pools. */
name?: string;
/** No. of worker threads to spawn and to be managed by the pool. */
size?: number;
}
```
### Transfer(transferable: [Transferable](https://developer.mozilla.org/de/docs/Web/API/Transferable)): TransferDescriptor
Mark transferable objects within an arbitrary object or array as
being a transferable object. They will then not be serialized
and deserialized on messaging with the main thread, but ownership
of them will be tranferred to the receiving thread.
Only array buffers, message ports and few more special types of
objects can be transferred, but it's much faster than serializing and
deserializing them.
Returns a `TransferDescriptor`, a container that holds the arraybuffer to be transferred.
> Note:
> The transferable object cannot be accessed by this thread again
> unless the receiving thread transfers it back again!
**Transferable**: transferable Array buffer, message port or similar.
See
### Thumbo.ImageFormat
Enums of supported image formats. Thumbo supports thumbnail creation for the following formats:
- Png
- Jpeg
- Gif
- Ico
- Svg
### Thumbo.thumbnail(bufferDescriptor: [TransferDescriptor](#transferdescriptor), format: [ImageFormat](#imageformat), width: number, height: number): Promise\
Creates a thumbnail from the provided arraybuffer transfer descriptor.
The provided arraybuffer is transferred to the worker for processing, once the task is completed, the newly created thumbnail arraybuffer
is transferred back to the main thread.
### Thumbo.thumbnailFromUrl(url: string, format: [ImageFormat](#imageformat), width: number, height: number): Promise\
Creates a thumbnail from the provided `Url`. Once the task is completed, the created thumbnail arraybuffer is transferred to the main thread.
### Thumbo.workers
Returns the workers in the pool
> Note:
> Accessing this property before thumbo is initialized will throw an error.
### Thumbo.completed(allowResolvingImmediately: boolean)
Returns a promise that resolves once the task queue is emptied.
Promise will be rejected if any task fails.
`allowResolvingImmediately` Set to `true` to resolve immediately if task queue is currently empty.
### Thumbo.settled(allowResolvingImmediately: boolean)
Returns a promise that resolves once the task queue is emptied.
Failing tasks will not cause the promise to be rejected.
`allowResolvingImmediately` Set to `true` to resolve immediately if task queue is currently empty.
> Note:
> Calling this function before thumbo is initialized will throw an error.
### Thumbo.uninit(force: boolean)
Returns a promise that resolves once the task queue is emptied.
Failing tasks will not cause the promise to be rejected.
`force` Set to `true` to kill the thread even if it cannot be stopped gracefully.
> Note:
> Calling this function before thumbo is initialized will throw an error.