jsii

README

JSII Go Runtime

This is the JSII runtime for go. This repository is used only for publishing the go module. The source code is managed in the main JSII repository. Refer to the go-runtime readme there for details on building and testing the module.

Documentation

Index

• func Close()
• func Create(fqn FQN, args []interface{}, interfaces []FQN, overrides []Override, ...)
• func Get(obj interface{}, property string, ret interface{}, implMap implementationMap)
• func Invoke(obj interface{}, method string, args []interface{}, hasReturn bool, ...)
• func InvokeStatic(fqn FQN, method string, args []interface{}, hasReturn bool, ret interface{}, ...)
• func Load(name string, version string, tarball []byte)
• func Set(obj interface{}, property string, value interface{})
• func StaticGet(fqn FQN, property string, ret interface{}, implMap implementationMap)
• func StaticSet(fqn FQN, property string, value interface{})
• type FQN
• type MethodOverride
• type Override
• type PropertyOverride

Functions

func Close

func Close()

Close finalizes the runtime process, signalling the end of the execution to the jsii kernel process, and waiting for graceful termination. The best practice is to defer call thins at the beginning of the "main" function.

If a jsii client is used *after* Close was called, a new jsii kernel process will be initialized, and Close should be called again to correctly finalize that, too. This behavior is intended for use in unit/integration tests.

func Create

func Create(fqn FQN, args []interface{}, interfaces []FQN, overrides []Override, ret interface{})

Create will construct a new JSII object within the kernel runtime. This is called by jsii object constructors.

func Get

func Get(obj interface{}, property string, ret interface{}, implMap implementationMap)

Get reads a property value on a given jsii class instance. The response should be decoded into the expected type of the property being read.

func Invoke

func Invoke(obj interface{}, method string, args []interface{}, hasReturn bool, ret interface{}, implMap implementationMap)

Invoke will call a method on a jsii class instance. The response should be decoded into the expected return type for the method being called.

func InvokeStatic

func InvokeStatic(fqn FQN, method string, args []interface{}, hasReturn bool, ret interface{}, implMap implementationMap)

InvokeStatic will call a static method on a given jsii class. The response should be decoded into the expected return type for the method being called.

func Load

func Load(name string, version string, tarball []byte)

Load ensures a npm package is loaded in the jsii kernel.

func Set

func Set(obj interface{}, property string, value interface{})

Set writes a property on a given jsii class instance. The value should match the type of the property being written, or the jsii kernel will crash.

func StaticGet

func StaticGet(fqn FQN, property string, ret interface{}, implMap implementationMap)

StaticGet reads a static property value on a given jsii class. The response should be decoded into the expected type of the property being read.

func StaticSet

func StaticSet(fqn FQN, property string, value interface{})

StaticSet writes a static property on a given jsii class. The value should match the type of the property being written, or the jsii kernel will crash.

Types

type FQN

type FQN string

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

type MethodOverride

type MethodOverride struct {
	Method *string `json:"method"`
	Cookie *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.

type Override

type Override interface {
	// 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 {
	Property *string `json:"property"`
	Cookie   *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.