graph

package

v0.0.0-...-7f9a81d Latest Latest Go to latest Published: Feb 27, 2023 License: MIT Imports: 16 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

Repository

github.com/siggy/gographs

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Start(addr string) error
type Client
- func NewClient(addr string) *Client
- func (c *Client) Get(repo string, cluster bool) (string, error)
type Post

Constants ¶

View Source

const DefaultGraphAddr = "localhost:8889"

DefaultGraphAddr defines the graph server's address when running locally. If the caller uses something other than the default it is assumed to be TLS'd.

Variables ¶

This section is empty.

Functions ¶

func Start ¶

func Start(addr string) error

Start initializes the graph server and starts listening.

Types ¶

type Client ¶

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

Client provides a client to the graph server.

func NewClient ¶

func NewClient(addr string) *Client

NewClient creates a client to the graph server.

func (*Client) Get ¶

func (c *Client) Get(repo string, cluster bool) (string, error)

Get takes a repo and cluster flag and returns a DOT representation of the repo.

type Post ¶

type Post struct {
	Repo    string `json:"repo"`
	Cluster bool   `json:"cluster"`
}

Post defines the input POST body to the `/graph` endpoint. curl --data '{"repo":"github.com/siggy/gographs","cluster":true}' -X POST [graph-addr]/graph

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL