Nuanced Pumpkin Mavens

    twilio-sync
    TypeScript icon, indicating that this package has built-in type declarations

    3.2.2 • Public • Published

    Twilio Sync JavaScript client library

    Twilio Sync is Twilio's state synchronization service, offering two-way real-time communication between browsers, mobiles, and the cloud. Visit our official site for more details: https://www.twilio.com/sync

    Installation

    via NPM

    npm install --save twilio-sync
    

    Using this method, you can require twilio-sync.js like so:

    const { SyncClient } = require('twilio-sync');
    const syncClient = new SyncClient(token);
    

    via CDN

    Releases of twilio-sync.js are hosted on a CDN, and you can include these directly in your web app using a <script> tag.

    <script type="text/javascript" src="//media.twiliocdn.com/sdk/js/sync/v3.2/twilio-sync.min.js"></script>
    

    Using this method, twilio-sync.js will set a browser global:

    const syncClient = new Twilio.Sync.Client(token);
    

    Usage

    To use the library, you need to generate an Access Token and pass it to the Sync Client constructor. The Twilio SDK Starter applications for Node.js, Java, PHP, Ruby, Python, C# provide an easy way to set up a token generator locally. Alternatively, you can set up a Twilio Function based on the Sync Access Token template.

    // Obtain a JWT access token: https://www.twilio.com/docs/sync/identity-and-access-tokens
    const token = '<your-access-token-here>';
    const syncClient = new Twilio.Sync.Client(token);
    
    // Open a Document by unique name and update its data
    syncClient.document('MyDocument')
      .then(function(document) {
        // Listen to updates on the Document
        document.on('updated', function(event) {
          console.log('Received Document update event. New data:', event.data);
        });
    
        // Update the Document data
        const newData = { temperature: 23 };
        return document.set(newData);
      })
      .then(function(updateResult) {
        console.log('The Document was successfully updated', updateResult)
      })
      .catch(function(error) {
        console.error('Unexpected error', error)
      });
    

    For more code examples for Documents and other Sync objects, refer to the SDK API Docs.

    Changelog

    See this link.

    Keywords

    none

    Install

    npm i twilio-sync

    DownloadsWeekly Downloads

    111,877

    Version

    3.2.2

    License

    MIT

    Unpacked Size

    13.1 MB

    Total Files

    99

    Last publish

    Collaborators

    • twilio-messaging