api

Documentation

Overview

Package api contains shared type definisions used by several modules part of the jsii runtime for go. It helps avoid creating circular dependencies between the other modules.

Index

• func IsMethodOverride(value Override) bool
• func IsPropertyOverride(value Override) bool
• type EnumRef
• type FQN
• type MethodOverride
  • func (m MethodOverride) GoName() string
• type ObjectRef
  • func (o *ObjectRef) TypeFQN() FQN
• type Override
• type PropertyOverride
  • func (m PropertyOverride) GoName() string
• type StructDescriptor
• type WireDate
• type WireMap
• type WireStruct

Functions

func IsMethodOverride

func IsMethodOverride(value Override) bool

func IsPropertyOverride

func IsPropertyOverride(value Override) bool

Types

type EnumRef

type EnumRef struct {
	MemberFQN string `json:"$jsii.enum"`
}

type FQN

type FQN string

FQN represents a fully-qualified type name in the jsii type system.

type MethodOverride

type MethodOverride struct {
	JsiiMethod string `json:"method"`
	GoMethod   string `json:"cookie"`
	// contains filtered or unexported fields
}

MethodOverride is used to register a "go-native" implementation to be substituted to the default javascript implementation on the created object.

func (MethodOverride) GoName

func (m MethodOverride) GoName() string

type ObjectRef

type ObjectRef struct {
	InstanceID string `json:"$jsii.byref"`
	Interfaces []FQN  `json:"$jsii.interfaces,omitempty"`
}

func (*ObjectRef) TypeFQN

func (o *ObjectRef) TypeFQN() FQN

type Override

type Override interface {
	GoName() string
	// contains filtered or unexported methods
}

Override is a public interface implementing a private method `isOverride` implemented by the private custom type `override`. This is embedded by MethodOverride and PropertyOverride to simulate the union type of Override = MethodOverride | PropertyOverride.

type PropertyOverride

type PropertyOverride struct {
	JsiiProperty string `json:"property"`
	GoGetter     string `json:"cookie"`
	// contains filtered or unexported fields
}

PropertyOverride is used to register a "go-native" implementation to be substituted to the default javascript implementation on the created object.

func (PropertyOverride) GoName

func (m PropertyOverride) GoName() string

type StructDescriptor

type StructDescriptor struct {
	FQN    FQN                    `json:"fqn"`
	Fields map[string]interface{} `json:"data"`
}

type WireDate

type WireDate struct {
	Timestamp string `json:"$jsii.date"`
}

type WireMap

type WireMap struct {
	MapData map[string]interface{} `json:"$jsii.map"`
}

type WireStruct

type WireStruct struct {
	StructDescriptor `json:"$jsii.struct"`
}