DefinitelyTyped/types/gapi.client.discovery/readme.md
Alexey Bolisov 4f8a3d571b Add Google APIs typings (#19083)
* Add Google APIs typings

* [gapi.cliebt.* ] Add version as part of typings name and fix gapi.client tslint errors

* versions should not get their own folders
fixing a few typos
using /** syntax so comments show up in editors
export only actual (last) version for now

* export only actual (last) version for now

* merge namespaces and remove unnecessary namespace qualifiers

* remove namespace qualifier for gapi.client.Request from nested namespaces and change Request base interface to Promise

* disable await-promise rule

* fix collision between gapi.client.Request and Request from nested namespace
disable no-irregular-whitespace rule

* sort properties and namespace resources

* remove empty comments
sort resources amd methods in tests and readme.md

* update 'this is autogenerated file' banner to remove this text from gapi.client namespace hint
use multiline comments when comment has several lines

* implement no-trailing-whitespace, no-padding, max-line-length, await-promise, no-irregular-whitespace rules

* add strictFunctionTypes to tsconfig

* fix "Whitespace within parentheses is not allowed" rule

* fix ts-lint rules

* fixes

* remove deprecated replicapool and replicapoolupdater api

* fix no-irregular-whitespace

* fix no-irregular-whitespace
2017-10-09 14:55:04 -07:00

1.0 KiB

TypeScript typings for APIs Discovery Service v1

Provides information about other Google APIs, such as what APIs are available, the resource, and method details for each API. For detailed description please check documentation.

Installing

Install typings for APIs Discovery Service:

npm install @types/gapi.client.discovery@v1 --save-dev

Usage

You need to initialize Google API client in your code:

gapi.load("client", () => { 
    // now we can use gapi.client
    // ... 
});

Then load api client wrapper:

gapi.client.load('discovery', 'v1', () => {
    // now we can use gapi.client.discovery
    // ... 
});

After that you can use APIs Discovery Service resources:

    
/* 
Retrieve the description of a particular version of an api.  
*/
await gapi.client.apis.getRest({ api: "api", version: "version",  }); 
    
/* 
Retrieve the list of APIs supported at this endpoint.  
*/
await gapi.client.apis.list({  });