1.4.113 • Published 11 months ago

@relaycorp/object-storage v1.4.113

Weekly downloads
46
License
MIT
Repository
github
Last release
11 months ago

@relaycorp/object-storage

This library allows you to interact with major object storage backends (e.g., Amazon S3) using a unified interface.

Install

Releases are automatically pushed to NPM. For example, to get the latest release, run:

npm install @relaycorp/object-storage

Supported backends

BackendNameSDK used internallyAccess/secret key support
Amazon S3s3AWSOptional
Google Cloud Storage (GCS)gcsGCPUnsupported. Use alternative authentication methods instead, like workload identity.
MiniominioAWSRequired

Supported operations

  • Get object (along with its metadata).
  • Create/update object (along with its metadata).
  • Delete object.
  • List objects under a given prefix. Pagination is handled automatically: We return an iterable and retrieve the next page lazily.

We welcome PRs to support additional operations, as long as each new operation is supported across all backends in a normalised way, and has unit and functional tests.

Example

import { initObjectStoreClient } from '@relaycorp/object-storage';

async function main(): Promise<void> {
  const client = initObjectStoreClient(
    process.env.STORE_BACKEND,
    process.env.STORE_ENDPOINT,
    process.env.STORE_ACCESS_KEY,
    process.env.STORE_SECRET_KEY,
  );

  for await (const objectKey of client.listObjectKeys("prefix/", process.env.STORE_BUCKET)) {
    console.log("- ", objectKey)
  }
}

API documentation

The API documentation can be found on docs.relaycorp.tech.

Contributing

We love contributions! If you haven't contributed to a Relaycorp project before, please take a minute to read our guidelines first.

1.4.113

11 months ago

1.4.112

1 year ago

1.4.111

1 year ago

1.4.110

1 year ago

1.4.109

1 year ago

1.4.108

1 year ago

1.4.107

1 year ago

1.4.106

1 year ago

1.4.105

1 year ago

1.4.104

1 year ago

1.4.103

1 year ago

1.4.102

1 year ago

1.4.101

1 year ago

1.4.100

1 year ago

1.4.99

1 year ago

1.4.98

1 year ago

1.4.97

2 years ago

1.4.96

2 years ago

1.4.95

2 years ago

1.4.86

2 years ago

1.4.88

2 years ago

1.4.87

2 years ago

1.4.89

2 years ago

1.4.91

2 years ago

1.4.90

2 years ago

1.4.93

2 years ago

1.4.92

2 years ago

1.4.94

2 years ago

1.4.85

2 years ago

1.4.80

2 years ago

1.4.82

2 years ago

1.4.81

2 years ago

1.4.84

2 years ago

1.4.83

2 years ago

1.4.79

2 years ago

1.4.75

2 years ago

1.4.74

2 years ago

1.4.77

2 years ago

1.4.76

2 years ago

1.4.78

2 years ago

1.4.73

2 years ago

1.4.68

2 years ago

1.4.69

2 years ago

1.4.71

2 years ago

1.4.70

2 years ago

1.4.72

2 years ago

1.4.60

3 years ago

1.4.62

3 years ago

1.4.61

3 years ago

1.4.64

3 years ago

1.4.63

3 years ago

1.4.66

2 years ago

1.4.65

2 years ago

1.4.67

2 years ago

1.4.59

3 years ago

1.4.55

3 years ago

1.4.54

3 years ago

1.4.57

3 years ago

1.4.56

3 years ago

1.4.58

3 years ago

1.4.48

3 years ago

1.4.47

3 years ago

1.4.49

3 years ago

1.4.51

3 years ago

1.4.50

3 years ago

1.4.53

3 years ago

1.4.52

3 years ago

1.4.33

3 years ago

1.4.35

3 years ago

1.4.34

3 years ago

1.4.37

3 years ago

1.4.36

3 years ago

1.4.39

3 years ago

1.4.38

3 years ago

1.4.40

3 years ago

1.4.42

3 years ago

1.4.41

3 years ago

1.4.44

3 years ago

1.4.43

3 years ago

1.4.46

3 years ago

1.4.45

3 years ago

1.4.31

3 years ago

1.4.32

3 years ago

1.4.24

3 years ago

1.4.26

3 years ago

1.4.25

3 years ago

1.4.28

3 years ago

1.4.27

3 years ago

1.4.29

3 years ago

1.4.30

3 years ago

1.4.20

3 years ago

1.4.22

3 years ago

1.4.21

3 years ago

1.4.23

3 years ago

1.4.19

3 years ago

1.4.9

3 years ago

1.4.11

3 years ago

1.4.10

3 years ago

1.4.13

3 years ago

1.4.12

3 years ago

1.4.15

3 years ago

1.4.14

3 years ago

1.4.17

3 years ago

1.4.16

3 years ago

1.4.18

3 years ago

1.4.6

4 years ago

1.4.8

4 years ago

1.4.7

4 years ago

1.4.5

4 years ago

1.4.4

4 years ago

1.4.3

4 years ago

1.4.2

4 years ago

1.4.1

4 years ago

1.4.0

4 years ago

1.3.10

4 years ago

1.3.9

4 years ago

1.3.7

4 years ago

1.3.8

4 years ago

1.3.6

4 years ago

1.3.5

4 years ago

1.3.4

4 years ago

1.3.3

4 years ago

1.3.2

4 years ago

1.3.1

4 years ago

1.3.0

4 years ago

1.2.1

4 years ago

1.2.0

4 years ago

1.1.0

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago