nodered

Documentation

Index

• type Client
  • func NewClient(host string, port int, username, password string) *Client
  • func (c *Client) CreateModule(packageName string) (*CreateModuleResponse, error)
  • func (c *Client) GetModule()
• type CreateModuleResponse
• type ErrorCode
• type ErrorResponse
• type NodeRedError
  • func (e *NodeRedError) Error() string

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is NOT thread-safe

func NewClient

func NewClient(host string, port int, username, password string) *Client

func (*Client) CreateModule

func (c *Client) CreateModule(packageName string) (*CreateModuleResponse, error)

func (*Client) GetModule

func (c *Client) GetModule()

type CreateModuleResponse

type CreateModuleResponse struct {
	Name string `json:"name,omitempty"`
}

type ErrorCode

type ErrorCode string

var (
	ErrorCodeUnexpectedError     ErrorCode = "unexpected_error"
	ErrorCodeInvalidRequest      ErrorCode = "invalid_request"
	ErrorCodeSettingsUnavailable ErrorCode = "settings_unavailable"
	ErrorCodeModuleAlreadyLoaded ErrorCode = "module_already_loaded"
	ErrorCodeTypeInUse           ErrorCode = "type_in_use"
	ErrorCodeInvalidAPIVersion   ErrorCode = "invalid_api_version"
)

type ErrorResponse

type ErrorResponse struct {
	Code    ErrorCode `json:"code"`
	Message string    `json:"message"`
}

type NodeRedError

type NodeRedError struct {
	StatusCode int
	Code       ErrorCode
	Message    string
}

func (*NodeRedError) Error

func (e *NodeRedError) Error() string