jdocs

package

v1.0.0 Latest Latest Go to latest Published: Jan 1, 2021 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func Run(ctx context.Context, optionValues ...Option)

Run starts the jdocs service

type Option func(o *options)

Option defines an option that can be set on the token server

func WithErrorListener(value util.ErrorListener) Option

WithErrorListener specifies that the given ErrorListener should be passed errors that result from jdoc requests

func WithServer() Option

WithServer specifies that an IPC server should be started so other processes can request jdocs from this process

func WithSocketNameSuffix(socketNameSuffix string) Option

WithSocketNameSuffix specifies the (optional) suffix of the socket name

func WithTokener(value token.Accessor) Option

WithTokener specifies that the given token.Accessor should be used to obtain authorization credentials