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

azure-mobile-apps-client

v2.0.1

Published

Javascript SDK for connecting to Azure Mobile Apps. For more details visit https://azure.microsoft.com/en-us/documentation/learning-paths/appservice-mobileapps/

Downloads

259

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

windowsazurewindowsazure

Keywords

microsoftazuremobilewindowsazureofficialappserviceapiapps

Readme

Azure Mobile Apps: Javascript Client SDK

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.

Support

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:

  • Android API 19-24 (KitKat through Nougat)
  • iOS versions 8.0 and later.
  • Windows Phone 8.1
  • Universal Windows Platform

The JavaScript client is also usable for data access in web clients. We support any platform that supports ECMAScript 5.1.

Usage instructions

You can consume the SDK in one of the following ways.

  1. Reference the SDK bundle in HTML's script tag
  2. Use the SDK bundle as a CommonJS module
  3. Use the SDK bundle as an AMD module
  4. Use the SDK as an npm package

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.

Sample usage

Here are a few examples of how you can use the SDK.

Use the SDK as a Javascript bundle

<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>

Use the SDK as an npm package

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.

Offline data sync

This page explains the offline data sync feature in detail.

API reference

Refer https://azure.github.io/azure-mobile-apps-js-client for detailed API reference.

SDK downloads

Build instructions

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.

Running Unit Tests

To run unit tests for the browser, run:

npm run browserut

Future work

Brief list of work planned in the future:

  • ability to cancel push and pull operations
  • triggering a push automatically when a pull is performed
  • support for math and date/time functions while querying for records
  • callback to allow changing how records are sent to the server during a push
  • configurable ID column. Currently ID column has to be named 'id'.

All these will be added over a series of updates in the next few days. Stay tuned!

Useful Resources

Contribute Code or Provide Feedback

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] 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.