# service-blobs-node > File blobs microservice Latest version **1.1.4** (published 2023-08-03) · MIT license · 0 weekly downloads ## Install ```sh npm install service-blobs-node pnpm add service-blobs-node yarn add service-blobs-node bun add service-blobs-node ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.1.4 | | Published | 2023-08-03 | | First published | 2022-05-06 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=14.0.0 | | Dependencies | 9 | | Unpacked size | 563.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | Conceptual Vision Consulting LLC | | Maintainers | pipdeveloper | | Keywords | pip.services, files, blobs, s3, microservice | ## Links - npm: https://www.npmjs.com/package/service-blobs-node - Repository: https://github.com/pip-services-infrastructure2/service-blobs-node - Homepage: https://github.com/pip-services-infrastructure2/service-blobs-node#readme - Issues: https://github.com/pip-services-infrastructure2/service-blobs-node/issues - npm.io page: https://npm.io/package/service-blobs-node ## Dependencies (9) - [pip-services3-aws-nodex](https://npm.io/package/pip-services3-aws-nodex.md) ^1.1.* - [pip-services3-rpc-nodex](https://npm.io/package/pip-services3-rpc-nodex.md) ^1.3.* - [pip-services3-data-nodex](https://npm.io/package/pip-services3-data-nodex.md) ^1.0.* - [pip-services3-grpc-nodex](https://npm.io/package/pip-services3-grpc-nodex.md) ^1.1.* - [pip-services3-commons-nodex](https://npm.io/package/pip-services3-commons-nodex.md) ^1.0.* - [pip-services3-mongodb-nodex](https://npm.io/package/pip-services3-mongodb-nodex.md) 1.0.* - [pip-services3-swagger-nodex](https://npm.io/package/pip-services3-swagger-nodex.md) ^1.0.0 - [pip-services3-container-nodex](https://npm.io/package/pip-services3-container-nodex.md) ^1.0.* - [pip-services3-components-nodex](https://npm.io/package/pip-services3-components-nodex.md) ^1.4.* ## Alternatives - [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads - [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads - [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads - [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads - [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads ## Recent versions - 1.1.4 (latest) — 2023-08-03 - 1.1.3 — 2023-05-30 - 1.1.2 — 2023-05-26 - 1.1.1 — 2023-02-27 - 1.1.0 — 2022-12-20 - 1.0.0 — 2022-05-06 ## README # Blobs Microservice This is blob blobs microservice from Pip.Services library. It stores large binary blobs, manages references to them from other entities and serves stored content to users. Most often binary blobs are used to store images and document attachments. The microservice currently supports the following deployment options: * Deployment platforms: Standalone Process, Seneca * External APIs: HTTP/REST, Seneca * Persistence: Memory, Flat Files, MongoDB, AWS S3 This microservice has no dependencies on other microservices. Quick Links: * [Download Links](doc/Downloads.md) * [Development Guide](doc/Development.md) * [Configuration Guide](doc/Configuration.md) * [Deployment Guide](doc/Deployment.md) * Client SDKs - [Node.js SDK](https://bitbucket.org/entinco/eic-services-infrastructure/src/master/client-blobs-node) * Communication Protocols - [HTTP Version 1](doc/HttpProtocolV1.md) - [Seneca Version 1](doc/SenecaProtocolV1.md) ## Contract Logical contract of the microservice is presented below. For physical implementation (HTTP/REST, Thrift, Seneca, Lambda, etc.), please, refer to documentation of the specific protocol. ```typescript class BlobInfoV1 { /* Identification */ public id: string; public group: string; public name: string; /* Content */ public size: number; public content_type: string; public create_time: Date; public expire_time: Date; public completed: boolean; } interface IBlobsV1 { getBlobsByFilter(correlationId: string, filter: FilterParams, paging: PagingParams): Promise>; getBlobsByIds(correlationId: string, blobIds: string[]): Promise; getBlobById(correlationId: string, blobId: string): Promise; getBlobUri(correlationId: string, blobId: string): Promise; beginBlobWrite(correlationId: string, blob: BlobInfoV1): Promise; writeBlobChunk(correlationId: string, token: string, chunk: string): Promise; endBlobWrite(correlationId: string, token: string, chunk: string): Promise; abortBlobWrite(correlationId: string, token: string): Promise; beginBlobRead(correlationId: string, blobId: string): Promise; readBlobChunk(correlationId: string, blobId: string, skip: number, take: number): Promise; endBlobRead(correlationId: string, blobId: string): Promise; updateBlobInfo(correlationId: string, blob: BlobInfoV1): Promise; markBlobsCompleted(correlationId: string, blobIds: string[]): Promise; deleteBlobById(correlationId: string, blobId: string): Promise; deleteBlobsByIds(correlationId: string, blobIds: string[]): Promise; } ``` ## Download Right now the only way to get the microservice is to check it out directly from github repository ```bash git clone git@github.com:pip-services-infrastructure2/service-blobs-node.git ``` Pip.Service team is working to implement packaging and make stable releases available for your as zip downloadable archieves. ## Run Add **config.yaml** file to the root of the microservice folder and set configuration parameters. As the starting point you can use example configuration from **config.example.yaml** file. Example of microservice configuration ```yaml { --- - descriptor: "pip-services-commons:logger:console:default:1.0" level: "trace" - descriptor: "service-blobs:persistence:file:default:1.0" path: "./data/blobs" - descriptor: "service-blobs:controller:default:default:1.0" - descriptor: "service-blobs:service:commandable-http:default:1.0" connection: protocol: "http" host: "0.0.0.0" port: 8080 } ``` For more information on the microservice configuration see [Configuration Guide](Configuration.md). Start the microservice using the command: ```bash node run ``` ## Use The easiest way to work with the microservice is to use client SDK. The complete list of available client SDKs for different languages is listed in the [Quick Links](#links) If you use Node.js then you should add dependency to the client SDK into **package.json** file of your project ```javascript { ... "dependencies": { .... "client-blobs-node": "^1.0.*", ... } } ``` Inside your code get the reference to the client SDK ```javascript var sdk = new require('client-blobs-node'); ``` Define client configuration parameters that match configuration of the microservice external API ```javascript // Client configuration var config = { connection: { protocol: 'http', host: 'localhost', port: 8080 } }; ``` Instantiate the client and open connection to the microservice ```javascript // Create the client instance var client = sdk.BlobsRestClient(config); // Connect to the microservice await client.open(null); // Work with the microservice ... ``` Now the client is ready to perform operations ```javascript // Create a new picture var blob = { group: "pictures", name: "google_search.jpg" }; await client.createBlobFromUrl( null, blob, "https://www.google.com/logos/doodles/2016/doodle-4-google-2016-us-winner-5664555055185920-hp.jpg", ); ``` ```javascript // Start reading blobs in chunks let size = await client.beginBlobRead( null, blob_id ); let chunk = await client.readBlobChunk( null, blob_id, 0, size ); ``` ## Acknowledgements This microservice was created and currently maintained by *Sergey Seroukhov*. --- _Source: https://npm.io/package/service-blobs-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._