azure-mobile-apps-client
Advanced tools
Javascript SDK for connecting to Azure Mobile Apps. For more details visit https://azure.microsoft.com/en-us/documentation/learning-paths/appservice-mobileapps/
With Microsoft Azure Mobile Apps you can add a scalable backend to your connected client applications in minutes. To learn more about Azure Mobile Apps, visit the Mobile Apps documentation.
This repository contains code for the azure-mobile-apps-client npm package and the cordova-plugin-ms-azure-mobile-apps Cordova plugin.
The Cordova plugin is published from the Azure/azure-mobile-apps-cordova-client repository by bundling source code in this repository. Refer Azure/azure-mobile-apps-cordova-client for more details about the Cordova plugin.
The following sections explain how to use the Javascript client SDK. You can also refer How to Use the JavaScript Client Library for Azure Mobile Apps for more details.
The JavaScript client is primarily suited to Apache Cordova uses. Offline Sync is only supported in Apache Cordova situations. We test on the following platforms for Apache Cordova v6.0.0:
The JavaScript client is also usable for data access in web clients. We support any platform that supports ECMAScript 5.1.
You can consume the SDK in one of the following ways.
The latest SDK bundle is available at https://zumo.blob.core.windows.net/sdk/azure-mobile-apps-client.js and https://zumo.blob.core.windows.net/sdk/azure-mobile-apps-client.min.js.
To use a specific version of the SDK (recommended), use the bundle at https://zumo.blob.core.windows.net/sdk/azure-mobile-apps-client.__VERSION__.js or https://zumo.blob.core.windows.net/sdk/azure-mobile-apps-client.__VERSION__.min.js, where _VERSION_ represents a valid version.
Here are a few examples of how you can use the SDK.
<html>
<head>
<script src="https://zumo.blob.core.windows.net/sdk/azure-mobile-apps-client.2.0.0.js"></script>
<script>
// Create a reference to the Azure App Service
var clientRef = new WindowsAzure.MobileServiceClient('https://YOUR-SITE-NAME.azurewebsites.net');
</script>
</head>
</html>
Install the SDK from npm: npm install azure-mobile-apps-client
OR
Install the SDK from github: npm install azure/azure-mobile-apps-js-client
You can now use it in your Javascript code as follows:
var WindowsAzure = require('azure-mobile-apps-client');
// Create a reference to the Azure App Service
var clientRef = new WindowsAzure.MobileServiceClient('https://YOUR-SITE-NAME.azurewebsites.net');
You can bundle your Javascript code using either WebPack or Browserify.
This page explains the offline data sync feature in detail.
Refer https://azure.github.io/azure-mobile-apps-js-client for detailed API reference.
To build the SDK bundle yourself, follow these steps:
git clone https://github.com/Azure/azure-mobile-apps-js-client.git
cd azure-mobile-apps-js-client
npm install
npm run build
The built files will be copied to the /dist directory. The bundles for use by a web app in a browser are azure-mobile-apps-client.js and azure-mobile-apps-client.min.js. The bundle for use by the azure/azure-mobile-apps-cordova-client repository is azure-mobile-apps-client-cordova.js.
To run unit tests for the browser, run:
npm run browserut
Brief list of work planned in the future:
All these will be added over a series of updates in the next few days. Stay tuned!
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.
If you would like to become an active contributor to this project please follow the instructions provided in Microsoft Azure Projects Contribution Guidelines.
If you encounter any bugs with the library please file an issue in the Issues section of the project.
FAQs
Javascript SDK for connecting to Azure Mobile Apps. For more details visit https://azure.microsoft.com/en-us/documentation/learning-paths/appservice-mobileapps/
We found that azure-mobile-apps-client demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.
Security News
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
Security News
The Linux Foundation is warning open source developers that compliance with global sanctions is mandatory, highlighting legal risks and restrictions on contributions.