Class Discovery (6.0.3)

Package

  constructor 
 ( 
 options 
 : 
  
 DiscoveryOptions 
 );

Discovery for discovering API endpoints

Parameter

Name

Description

options

 DiscoveryOptions

Options for discovery

  discoverAllAPIs 
 ( 
 discoveryUrl 
 : 
  
 string 
 ) 
 : 
  
 Promise 
< {}>;

Generate all APIs and return as in-memory object.

Parameter

Name

Description

discoveryUrl

 string

Returns

Type

Description

 Promise 
<{}>

  discoverAPI 
 ( 
 apiDiscoveryUrl 
 : 
  
 string 
  
 | 
  
 { 
  
 url 
 ?: 
  
 string 
 ; 
  
 }) 
 : 
  
 Promise<EndpointCreator> 
 ;

Generate API file given discovery URL

Parameter

Name

Description

apiDiscoveryUrl

 string | {
        url?: string;
    }

URL or filename of discovery doc for API

Returns

Type

Description

 Promise 
< EndpointCreator 
>

A promise that resolves with a function that creates the endpoint