npm.io
0.0.3 • Published 5 years ago

fm-bridge

Licence
MIT
Version
0.0.3
Deps
3
Size
327 kB
Vulns
23
Weekly
0

ForceManager Bridge

Communication service for ForceManager Fragments.

Travis

Installation

ForceManager Bridge is available as an npm & yarn package.

As a dependency.

With yarn (recommended):

yarn add fm-bridge

With npm:

npm install fm-bridge
As a script.
<script
  type="text/javascript"
  src="https://d15abo3q1yyhdy.cloudfront.net/fragments/fm-bridge.min.js"
></script>
;

️ Features

  • Axios instance configured to make calls to ForceManager API.
  • Function getContext to get the context (user, account, etc.).

Usage

In the following example we can see how to get the ID of the current account using the bridge and make an API call to get the details of this account usings the axios instance.

Example importing the package as a dependency.
import { bridge, axios } from 'fm-bridge';

bridge
  .getContext()
  .then(({ data }) => axios.get(`/accounts/${data.entity.id.toString()}`))
  .then(({ data }) => {
    console.log('Account details:', data);
  })
  .catch((err) => {
    console.warn(err);
  });
Example importing the package as script.
<script
  type="text/javascript"
  src="https://d15abo3q1yyhdy.cloudfront.net/fragments/fm-bridge.min.js"
></script>
;

<script>
  fmBridge.bridge.getContext()
   .then(function(res) {
     return fmBridge.axios.get(`/accounts/${res.data.entity.id.toString()}`)
   })
   .then(function((res)) {
     console.log('Account details:', res.data);
   })
   .catch(function(err) {
     console.warn(err);
   });
</script>

Keywords