JSPM

@settlemint/sdk-minio

1.2.2-pr78a270a7
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 6084
  • Score
    100M100P100Q131494F
  • License FSL-1.1-MIT

MinIO integration module for SettleMint SDK, providing S3-compatible object storage capabilities

Package Exports

  • @settlemint/sdk-minio
  • @settlemint/sdk-minio/package.json

Readme

SettleMint logo

SettleMint SDK

✨ https://settlemint.com ✨
Integrate SettleMint into your application with ease.

CI status License npm stars

Documentation   •   NPM   •   Issues

Table of Contents

About

The SettleMint MinIO SDK provides a simple way to interact with MinIO object storage through the SettleMint platform. It enables you to easily store and retrieve files using MinIO's S3-compatible API in a secure and scalable manner.

For detailed information about using MinIO with the SettleMint platform, check out our official documentation.

API Reference

Functions

createServerMinioClient()

createServerMinioClient(options): object

Defined in: sdk/minio/src/minio.ts:24

Creates a MinIO client for server-side use with authentication.

Parameters
Parameter Type Description
options { accessKey: string; accessToken: string; instance: string; secretKey: string; } The server client options for configuring the MinIO client
options.accessKey string The MinIO access key used to authenticate with the MinIO server
options.accessToken string The access token used to authenticate with the SettleMint platform
options.instance string The URL of the MinIO instance to connect to
options.secretKey string The MinIO secret key used to authenticate with the MinIO server
Returns

object

An object containing the initialized MinIO client

Name Type Defined in
client Client sdk/minio/src/minio.ts:24
Throws

Will throw an error if not called on the server or if the options fail validation

Example
import { createServerMinioClient } from "@settlemint/sdk-minio";

const { client } = createServerMinioClient({
  instance: process.env.SETTLEMINT_MINIO_ENDPOINT!,
  accessToken: process.env.SETTLEMINT_ACCESS_TOKEN!,
  accessKey: process.env.SETTLEMINT_MINIO_ACCESS_KEY!,
  secretKey: process.env.SETTLEMINT_MINIO_SECRET_KEY!
});
client.listBuckets();

Contributing

We welcome contributions from the community! Please check out our Contributing guide to learn how you can help improve the SettleMint SDK through bug reports, feature requests, documentation updates, or code contributions.

License

The SettleMint SDK is released under the FSL Software License. See the LICENSE file for more details.