npm

Documentation

Overview

Package npm implements functions for iteracting with the npm registry

Index

• Constants
• func Register(ext *sqlite.ExtensionApi, opt *options.Options) (_ sqlite.ErrorCode, err error)
• type Client
  • func NewClient(httpClient *http.Client, logger *zerolog.Logger) *Client
  • func (c *Client) GetPackage(ctx context.Context, packageName string) ([]byte, error)
  • func (c *Client) GetPackageVersion(ctx context.Context, packageName, version string) ([]byte, error)
• type GetPackage
  • func (f *GetPackage) Apply(ctx *sqlite.Context, values ...sqlite.Value)
  • func (f *GetPackage) Args() int
  • func (f *GetPackage) Deterministic() bool

Constants

const (
	BaseURL = "https://registry.npmjs.org"
)

Functions

func Register

func Register(ext *sqlite.ExtensionApi, opt *options.Options) (_ sqlite.ErrorCode, err error)

Register registers npm API related functionality as a SQLite extension

Types

type Client

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

func NewClient

func NewClient(httpClient *http.Client, logger *zerolog.Logger) *Client

NewClient creates a new API client from an *http.Client. Pass nil to use http.DefaultClient

func (*Client) GetPackage

func (c *Client) GetPackage(ctx context.Context, packageName string) ([]byte, error)

GetPackage makes an HTTP request to https://registry.npmjs.org/<<packageName>> and returns the JSON response

func (*Client) GetPackageVersion

func (c *Client) GetPackageVersion(ctx context.Context, packageName, version string) ([]byte, error)

GetPackageVersion makes an HTTP request to https://registry.npmjs.org/<<packageName>>/<<version>> and returns the JSON response

type GetPackage

type GetPackage struct{ *Client }

func (*GetPackage) Apply

func (f *GetPackage) Apply(ctx *sqlite.Context, values ...sqlite.Value)

func (*GetPackage) Args

func (f *GetPackage) Args() int

func (*GetPackage) Deterministic

func (f *GetPackage) Deterministic() bool