Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 787 Commits
.azure-pipelines		.azure-pipelines
.github		.github
.vscode		.vscode
README-Localized		README-Localized
scripts/src		scripts/src
spec		spec
.gitignore		.gitignore
.npmignore		.npmignore
.release-please-manifest.json		.release-please-manifest.json
CHANGELOG.md		CHANGELOG.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
microsoft-graph.d.ts		microsoft-graph.d.ts
package-lock.json		package-lock.json
package.json		package.json
release-please-config.json		release-please-config.json
tsconfig.json		tsconfig.json
typings-demo.gif		typings-demo.gif
typings.json		typings.json

Repository files navigation

Microsoft Graph TypeScript Types

The Microsoft Graph TypeScript definitions enable editors to provide intellisense on Microsoft Graph objects including users, messages, and groups.

NOTE: TheMicrosoft Graph TypeScript Types Betanpm package andGitHub repo is now available. Imports from themicrosoftgraph/msgraph-typescript-typings#beta branch will no longer be supported.

Installation

We recommend including the .d.ts file by downloading this package throughnpm.

# Install types and save in package.json as a development dependencynpm install @microsoft/microsoft-graph-types --save-dev

Examples

The following examples assume that you have a valid access token. The following example usesisomorphic-fetch andMicrosoft Graph JavaScript client library -

import{User}from"@microsoft/microsoft-graph-types-beta";import{Client}from"@microsoft/microsoft-graph-client";import'isomorphic-fetch';constclient=Client.initWithMiddleware({defaultVersion:'beta',    ...});constresponse=awaitclient.api("/me").get();constuser=responseasUser;

Example of creating an object

// Create the message object// Note that all the properties must follow the interface definitions.// For example, this will not compile if you try to type "xml" instead of "html" for contentType.letmail:MicrosoftGraphBeta.Message={subject:"Microsoft Graph TypeScript Sample",toRecipients:[{emailAddress:{address:"microsoftgraph@example.com"}}],body:{content:"<h1>Microsoft Graph TypeScript Sample</h1>Try modifying the sample",contentType:"html"}}

Example of using v1 types and beta types together

"devDependencies": {// import published v1.0 types with a version from NPM"@microsoft/microsoft-graph-types":"^0.4.0",// import beta types with a version from NPM"@microsoft/microsoft-graph-types-beta":"^0.1.0-preview"  }}

import*asMicrosoftGraphfrom"@microsoft/microsoft-graph-types"import*asMicrosoftGraphBetafrom"@microsoft/microsoft-graph-types-beta"constv1User:MicrosoftGraph.User={givenName:"V1 User"}constbetaUser:MicrosoftGraphBeta.User={givenName:"Beta User"}

Supported editors

Any TypeScript project can consume these types when using at least TypeScript 2.0. We've tested including the types as a dependency in the following editors.

Visual Studio Code
WebStorm
Atom with theatom-typescript plugin

Questions and comments

We'd love to get your feedback about the TypeScript definitions project. You can send your questions and suggestions to us in theIssues section of this repository.

Contributing

Please see thecontributing guidelines.

Additional resources

Security Reporting

If you find a security issue with our libraries or services please report it tosecure@microsoft.com with as much detail as possible. Your submission may be eligible for a bounty through theMicrosoft Bounty program. Please do not post security issues to GitHub Issues or any other public site. We will contact you shortly upon receiving the information. We encourage you to get notifications of when security incidents occur by visitingthis page and subscribing to Security Advisory Alerts.