Skip to content

Commit

Permalink
Better docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kegsay committed Sep 30, 2024
1 parent 264d458 commit 7ed40c6
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion internal/api/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,13 @@ type Client interface {

// TestClient is a Client with extra helper functions added to make writing tests easier.
// Client implementations are not expected to implement these helper functions, and are
// instead composed together by the test rig itself. See TestClientImpl.
// instead composed together by the test rig itself.
type TestClient interface {
Client
MustStartSyncing(t ct.TestLike) (stopSyncing func())
}

// NewTestClient wraps a Client implementation with helper functions which tests can use.
func NewTestClient(c Client) TestClient {
return &testClientImpl{
Client: c,
Expand Down

0 comments on commit 7ed40c6

Please sign in to comment.