npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@smcloudstore/azure-storage

v0.2.0

Published

Azure Storage library for SMCloudStore

Downloads

439

Readme

@smcloudstore/azure-storage

This package is a provider for SMCloudStore, for Azure Blob Storage. SMCloudStore is a lightweight Node.js module that offers a simple API to interact with the object storage services of multiple cloud providers.

Please refer to the main package for the SMCloudStore documentation and instructions on how to use it.

Provider-specific considerations

There are a few provider-specific considerations for the AzureStorage provider.

Connection argument

When initializing the AzureStorage provider, the connection argument can be one of the following:

  • A string containing the full "connection string" for the storage account, for example as copied from the Azure Portal. This looks like 'DefaultEndpointsProtocol=https;AccountName=...;AccountKey=...;EndpointSuffix=core.windows.net'.
  • Alternatively, you can pass the connection options as a dictionary:
    • connection.storageAccount: string containing the Storage Account name
    • connection.storageAccessKey: string containing the Storage Account access key (the "secret key")
    • connection.host (optional): string containing the endpoint to use: this is useful if you're using Azure China (core.chinacloudapi.cn) or Azure Germany (core.cloudapi.de), or if you're using Azure Stack. Default value is core.windows.net, which is the default for public, global Azure regions.

Example:

// Require the package
const SMCloudStore = require('smcloudstore')

// Complete with the connection options for Azure Blob Storage
const connection = {
    storageAccount: 'STORAGE_ACCOUNT_NAME',
    storageAccessKey: 'SECRET_KEY_HERE'
}

// Return an instance of the AzureStorageProvider class
const storage = SMCloudStore.create('azure-storage', connection)

Creating a container

When using the storage.createContainer(container, [options]) and the storage.ensureContainer(container, [options]) methods, the options argument can be used to define some options for the container:

  • options.access (optional): string determining the permission level for the container and its contents. Please refer to the documentation for more informatiom.
    • 'container' (alias 'public' for compatibility with other storage providers)
    • 'blob'
    • 'none' (alias 'private' for compatibility with other storage providers)), this is the default value.

Using pre-signed URLs

In the method storage.presignedPutUrl(container, path, [options], [ttl]), the Azure Storage provider accepts for the options argument the same dictionary as the 'storage.putObject(container, path, data, [options])' method. If you specify a Content-Type in the request for the presigned URL, for example, clients will need to make PUT requests with the same Content-Type.

When uploading an object using a PUT request, Azure Storage requires clients to send an additional header with the request (case-insensitive):

X-MS-Blob-Type: BlockBlob

For example, with curl:

curl \
  --request PUT \
  --upload-file "/path/to/file" \
  --header 'X-MS-Blob-Type: BlockBlob' \
  "https://storageaccount.blob.storage.windows.net/path?token=..."

Lastly, please note that Azure Storage supports PUT upload operations with objects no larger than 100 MB. Trying to upload larger objects will fail.

Accessing the Azure Storage SDK

The Azure Blob Storage provider is built on top of the official Azure Storage SDK for Node.js, which is exposed by calling storage.client().

You can use the object returned by this method to perform low-level operations using the Azure Storage SDK.