@azure/core-lro
is a JavaScript library that manages long running operations (LROs) against Azure services. Until completion, such operations require consecutive calls to Azure services to update a local representation of the remote operation status.
Please note: This library is included with other Azure SDK libraries that need it. It should not be used as a direct dependency in your projects.
@azure/core-lro
is made following our Long Running Operations guidelines
Key links:
To install this library for a project under the azure-sdk-for-js
, make sure you are at the root of that project, then use Rush as follows:
rush add -p @azure/core-lro
To install this package outside of the azure-sdk-for-js
, use npm install --save @azure/core-lro
.
TypeScript users need to have Node type definitions installed:
npm install @types/node
They will also need to enable compilerOptions.allowSyntheticDefaultImports
in their
tsconfig.json
. Note that if you have enabled compilerOptions.esModuleInterop
,
allowSyntheticDefaultImports
is enabled by default.
See TypeScript's compiler options handbook
for more information.
@azure/core-lro makes a distinction between the Long Running Operation and its Poller.
You will be able to find some working examples of an implementation of an operation and a poller in:
Logs can be added at the discretion of the library implementing the Long Running Operation poller. Packages inside of azure-sdk-for-js use @azure/logger.
Please take a look at the samples directory for detailed examples on how to use this library.
If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.
To run our tests, first install the dependencies (with npm install
or rush install
),
then run the unit tests with: npm run unit-test
.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Generated using TypeDoc