Skip to main content

Class: InterfaceTypeDef

A definition of a custom interface defined in a Module.

Extends​

  • BaseClient

Constructors​

new InterfaceTypeDef()​

new InterfaceTypeDef(parent?, _id?, _description?, _name?, _sourceModuleName?): InterfaceTypeDef

Constructor is used for internal usage only, do not create object from it.

Parameters​

• parent?

• parent.ctx?: Context

• parent.queryTree?: QueryTree[]

• _id?: InterfaceTypeDefID

• _description?: string

• _name?: string

• _sourceModuleName?: string

Returns​

InterfaceTypeDef

Overrides​

BaseClient.constructor

Methods​

description()​

description(): Promise<string>

The doc string for the interface, if any.

Returns​

Promise<string>

functions()​

functions(): Promise<Function_[]>

Functions defined on this interface, if any.

Returns​

Promise<Function_[]>

id()​

id(): Promise<InterfaceTypeDefID>

A unique identifier for this InterfaceTypeDef.

Returns​

Promise<InterfaceTypeDefID>

name()​

name(): Promise<string>

The name of the interface.

Returns​

Promise<string>

sourceMap()​

sourceMap(): SourceMap

The location of this interface declaration.

Returns​

SourceMap

sourceModuleName()​

sourceModuleName(): Promise<string>

If this InterfaceTypeDef is associated with a Module, the name of the module. Unset otherwise.

Returns​

Promise<string>