microsoft-teams-deep-link

A module to help generate deep links for Microsoft Teams

Installation

npm install microsoft-teams-deep-link --save
yarn add microsoft-teams-deep-link

Usage

JavaScript

var teamsDeepLink = require('microsoft-teams-deep-link');
var deepLink = teamsDeepLink.getEntityDeepLink(
  {
    entityId: "someEntityId",
    entityWebUrl: "someEntityWebUrl",
    entityLabel: "someEntityLabel"
  },
  "someAppId"
);
console.log(deepLink);

Output should be "https://teams.microsoft.com/l/entity/someAppId/_djb2_msteams_prefix_3116810623?webUrl=someEntityWebUrl&label=someEntityLabel"

TypeScript

import { getEntityDeepLink } from 'microsoft-teams-deep-link';
let deepLink = getEntityDeepLink(
  {
    entityId: "someEntityId",
    entityWebUrl: "someEntityWebUrl",
    entityLabel: "someEntityLabel"
  },
  "someAppId"
);
console.log(deepLink);

Output should be "https://teams.microsoft.com/l/entity/someAppId/_djb2_msteams_prefix_3116810623?webUrl=someEntityWebUrl&label=someEntityLabel"

Build & Test

npm install
npm run build
npm run cover