JSPM

  • Created
  • Published
  • Downloads 572
  • Score
    100M100P100Q111332F
  • License Apache-2.0

Client SDK for Momento services

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@gomomento/sdk-web) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    logo

    project status project stability

    Momento JavaScript Web Client Library

    Momento Cache is a fast, simple, pay-as-you-go caching solution without any of the operational overhead required by traditional caching solutions. This repo contains the source code for the Momento JavaScript Web client library.

    To get started with Momento you will need a Momento Auth Token. You can get one from the Momento Console.

    Packages

    The JavaScript Web SDK is available on npmjs: @gomomento/sdk-web.

    The web SDK is the best choice for client-side JavaScript applications, such as code that will run in a browser. For node.js server-side applications, check out the Momento Node.js SDK.

    Usage

    import {CacheGet, CacheClient, Configurations, CredentialProvider} from '@gomomento/sdk-web';
    import {initJSDom} from './utils/jsdom';
    async function main() {
      // Because the Momento Web SDK is intended for use in a browser, we use the JSDom library to set up an environment
      // that will allow us to use it in a node.js program.
      initJSDom();
      const cacheClient = new CacheClient({
        configuration: Configurations.Laptop.v1(),
        credentialProvider: CredentialProvider.fromEnvironmentVariable({
          environmentVariableName: 'MOMENTO_API_KEY',
        }),
        defaultTtlSeconds: 60,
      });
    
      await cacheClient.createCache('cache');
      await cacheClient.set('cache', 'foo', 'FOO');
      const getResponse = await cacheClient.get('cache', 'foo');
      if (getResponse instanceof CacheGet.Hit) {
        console.log(`Got value: ${getResponse.valueString()}`);
      }
    }
    
    main().catch(e => {
      throw e;
    });
    

    Getting Started and Documentation

    Documentation is available on the Momento Docs website.

    Examples

    Working example projects, with all required build configuration files, are available in the examples subdirectory.

    Developing

    If you are interested in contributing to the SDK, please see the CONTRIBUTING docs.


    For more info, visit our website at https://gomomento.com!