dl

Documentation

Overview

Package dl implements documentation downloading facility.

Index

• Constants
• Variables
• type Client
  • func NewClient(opt Options) (*Client, error)
  • func (c *Client) Get(ctx context.Context, layer int, key string) ([]byte, error)
• type HTTPClient
• type Options

Constants

const NoLayer = 0

NoLayer can be passed as "layer" argument.

Variables

var ErrReadOnly = errors.New("write operation in read only mode")

Types

type Client

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

func NewClient

func NewClient(opt Options) (*Client, error)

func (*Client) Get

func (c *Client) Get(ctx context.Context, layer int, key string) ([]byte, error)

Get fetches documentation by key and layer.

Pass "NoLayer" as layer to use default documentation. Examples for "key" value:

• "schema" for index of documentation
• "constructor/inputMediaGeoLive" for constructor "inputMediaGeoLive"
• "type/InputMedia" for class "InputMedia"
• "method/messages.addChatUser" for "messages.addChatUser" method

Blank key is invalid.

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

type Options

type Options struct {
	Client   HTTPClient
	Host     string
	Path     string
	Readonly bool
	FromZip  bool
}