samples

Getting started with samples

Install the library

Copy the sample file you want to a folder of your choice and run the following command in your samples folder to install the npm package for Azure Storage File library.

npm install @azure/storage-file-share@12.0.0-preview.6

Or, in case you have cloned the repo and want to utilize the published npm package instead of src code, run the following commands in the samples folder to initialize an npm project and to install the storage-file-share package.

npm init -y
npm install @azure/storage-file-share@12.0.0-preview.6

Running Samples

Also, change "../.." to "@azure/storage-file-share" in the samples in order to import the published package instead of using source code.

Get account credentials of your storage account

• In the Azure Portal, go to Dashboard > Storage > your-storage-account.
• Note down the "AccountName", "AccountKey" obtained at Access keys and "AccountSAS" from Shared access signature under Settings tab. Before running any of the samples, update with the credentials you have noted down above.

Javascript sample

Copy the sample to your samples folder and use node to run it.

node sample.js

Typescript sample

If you don't have Typescript installed, then use npm to install it first.

npm install -g typescript

One way to run Typescript samples is to use ts-node. To install ts-node, run the below in your sample folder

npm install -g ts-node

Copy the sample to your samples folder and use ts-node to run it.

ts-node sample.ts