sbjs

Documentation

Index

• Variables
• func FprintZipData(dest *bytes.Buffer, zipData []byte)
• func New(c *sbi.Config) sbi.Plugin
• type Plugin
  • func (*Plugin) DescriptionForParams() map[string]string
  • func (p *Plugin) Encode(path, relPath string, fi os.FileInfo, err error) error
  • func (p *Plugin) Example(f *os.File)
  • func (*Plugin) ExampleFileName() string
  • func (p *Plugin) Source(f *os.File, fn func())
  • func (*Plugin) SourceFileName() string

Variables

var (
	// ErrUnknowAlgorithm in sbi
	ErrUnknowAlgorithm = sbi.ErrUnknowAlgorithm
)

Functions

func FprintZipData

func FprintZipData(dest *bytes.Buffer, zipData []byte)

FprintZipData converts zip binary contents to a string literal.

func New

func New(c *sbi.Config) sbi.Plugin

New is the entry of the plugin

Types

type Plugin

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

Plugin is the lib for js

func (*Plugin) DescriptionForParams

func (*Plugin) DescriptionForParams() map[string]string

DescriptionForParams to print help info

func (*Plugin) Encode

func (p *Plugin) Encode(path, relPath string, fi os.FileInfo, err error) error

Encode is the func for generater

func (*Plugin) Example

func (p *Plugin) Example(f *os.File)

Example help user to know how to use the library

func (*Plugin) ExampleFileName

func (*Plugin) ExampleFileName() string

ExampleFileName return the FileName of the example

func (*Plugin) Source

func (p *Plugin) Source(f *os.File, fn func())

Source generater the block

func (*Plugin) SourceFileName

func (*Plugin) SourceFileName() string

SourceFileName return the FileName of the source