package index

Import Path
	golang.org/x/pkgsite/internal/index (on go.dev)

Dependency Relation
	imports 14 packages, and imported by 2 packages

Involved Source Files

	   d➜ index.go
		Package index provides a client for communicating with the module index.

	      test_helper.go
Package-Level Type Names (only one, which is exported)

	/* sort exporteds by: alphabet | popularity */
	 type Client (struct)
		A Client is used by the worker service to communicate with the module index.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			httpClient *http.Client
				client used for HTTP requests. It is mutable for testing purposes.

			url string
				URL of the module index

		Methods (total 2, in which 1 are exported)
			(*T) GetVersions(ctx context.Context, since time.Time, limit int) (_ []*internal.IndexVersion, err error)
				GetVersions queries the index for new versions.

			/* one unexported ... *//* one unexported: */
			(*T) pollURL(since time.Time, limit int) string
		As Outputs Of (at least 2, both are exported)
			func New(rawurl string) (_ *Client, err error)
			func SetupTestIndex(t *testing.T, versions []*internal.IndexVersion) (*Client, func())


Package-Level Functions (total 2, both are exported)

	 func New(rawurl string) (_ *Client, err error)
		New constructs a *Client using the provided rawurl, which is expected to
		be an absolute URI that can be directly passed to http.Get.

	 func SetupTestIndex(t *testing.T, versions []*internal.IndexVersion) (*Client, func())
		SetupTestIndex creates a module index for testing using the given version
		map for data.  It returns a function for tearing down the index server after
		the test is completed, and a Client for interacting with the test index.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.