depsdev

Documentation

Index

• Constants
• Variables
• func MakeVersionRequests(queries []*depsdevpb.GetVersionRequest) ([][]models.License, error)
• func MakeVersionRequestsWithContext(ctx context.Context, queries []*depsdevpb.GetVersionRequest) ([][]models.License, error)
• func VersionQuery(system depsdevpb.System, name string, version string) *depsdevpb.GetVersionRequest

Constants

const DepsdevAPI = "api.deps.dev:443"

DepsdevAPI is the URL to the deps.dev API. It is documented at docs.deps.dev/api.

Variables

var System = map[lockfile.Ecosystem]depsdevpb.System{
	lockfile.NpmEcosystem:   depsdevpb.System_NPM,
	lockfile.NuGetEcosystem: depsdevpb.System_NUGET,
	lockfile.CargoEcosystem: depsdevpb.System_CARGO,
	lockfile.GoEcosystem:    depsdevpb.System_GO,
	lockfile.MavenEcosystem: depsdevpb.System_MAVEN,
	lockfile.PipEcosystem:   depsdevpb.System_PYPI,
}

System maps from a lockfile system to the depsdev API system.

Functions

func MakeVersionRequests

func MakeVersionRequests(queries []*depsdevpb.GetVersionRequest) ([][]models.License, error)

MakeVersionRequests wraps MakeVersionRequestsWithContext using context.Background.

func MakeVersionRequestsWithContext

func MakeVersionRequestsWithContext(ctx context.Context, queries []*depsdevpb.GetVersionRequest) ([][]models.License, error)

MakeVersionRequestsWithContext calls the deps.dev GetVersion gRPC API endpoint for each query. It makes these requests concurrently, sharing the single HTTP/2 connection. The order in which the requests are specified should correspond to the order of licenses returned by this function.

func VersionQuery

func VersionQuery(system depsdevpb.System, name string, version string) *depsdevpb.GetVersionRequest

VersionQuery constructs a GetVersion request from the arguments.