typesense

Documentation

Overview

Package typesense implements the Typesense protocol plugin.

Index

• func New() plugin.Plugin
• func Routes() []plugin.Route
• type Options
• type Plugin
  • func (Plugin) Connect(ctx context.Context, cfg plugin.ConnectConfig) (plugin.Session, error)
  • func (Plugin) Manifest() plugin.Manifest
  • func (Plugin) Routes() []plugin.Route
• type Session
  • func (s *Session) Close() error
  • func (s *Session) HealthCheck(ctx context.Context) error
  • func (s *Session) OpenChannel(context.Context, plugin.ChannelRequest) (plugin.Channel, error)

Functions

func New

func New() plugin.Plugin

func Routes

func Routes() []plugin.Route

Types

type Options

type Options struct {
	Endpoint  string
	APIKey    string
	TLSConfig *tls.Config
	Timeout   time.Duration
	PageLimit int
	ReadOnly  bool
}

type Plugin

type Plugin struct{}

func (Plugin) Connect

func (Plugin) Connect(ctx context.Context, cfg plugin.ConnectConfig) (plugin.Session, error)

func (Plugin) Manifest

func (Plugin) Manifest() plugin.Manifest

func (Plugin) Routes

func (Plugin) Routes() []plugin.Route

type Session

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

func (*Session) Close

func (s *Session) Close() error

func (*Session) HealthCheck

func (s *Session) HealthCheck(ctx context.Context) error

func (*Session) OpenChannel

func (s *Session) OpenChannel(context.Context, plugin.ChannelRequest) (plugin.Channel, error)