romdo/gomockctx
1
0
Fork 0
mirror of https://github.com/romdo/gomockctx.git synced 2026-02-19 08:06:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(readme): add basic details

Browse Source
This commit is contained in:
Jim Myhrberg
2022-02-15 01:00:00 +00:00
parent 4cfcb02266
commit 3610ef9e4a
1 changed files with 48 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@@ -1,4 +1,49 @@
# gomockctx <h1 align="center">
gomockctx
</h1>
Go package with [gomock](https://github.com/golang/mock) helpers for matching <p align="center">
[context.Context](https://pkg.go.dev/context). <strong>
Go package with <a href="https://github.com/golang/mock">gomock</a> helpers
for matching <a href="https://pkg.go.dev/context">context.Context</a>.
</strong>
</p>
<p align="center">
<a href="https://pkg.go.dev/github.com/romdo/gomockctx"><img src="https://img.shields.io/badge/%E2%80%8B-reference-387b97.svg?logo=go&logoColor=white" alt="Go Reference"></a>
<a href="https://github.com/romdo/gomockctx/actions"><img src="https://img.shields.io/github/workflow/status/romdo/gomockctx/CI.svg?logo=github" alt="Actions Status"></a>
<a href="https://codeclimate.com/github/romdo/gomockctx"><img src="https://img.shields.io/codeclimate/coverage/romdo/gomockctx.svg?logo=code%20climate" alt="Coverage"></a>
<a href="https://github.com/romdo/gomockctx/issues"><img src="https://img.shields.io/github/issues-raw/romdo/gomockctx.svg?style=flat&logo=github&logoColor=white" alt="GitHub issues"></a>
<a href="https://github.com/romdo/gomockctx/pulls"><img src="https://img.shields.io/github/issues-pr-raw/romdo/gomockctx.svg?style=flat&logo=github&logoColor=white" alt="GitHub pull requests"></a>
<a href="https://github.com/romdo/gomockctx/blob/main/LICENSE"><img src="https://img.shields.io/github/license/romdo/gomockctx.svg?style=flat" alt="License Status"></a>
</p>
## Import
```go
import "github.com/romdo/gomockctx"
```
## Usage
```go
// Create a context with a gomockctx ID value.
ctx := gomockctx.New(context.Background())
// Match against a context with a gomockctx ID.
someMock.EXPECT().
Get(gomockctx.Is(ctx), "foo").
Return("bar", nil)
// Use context with gomockctx ID when calling function.
someMock.Get(ctx, "foo")
```
## Documentation
Please see the
[Go Reference](https://pkg.go.dev/github.com/romdo/gomockctx#section-documentation).
## License
[MIT](https://github.com/romdo/gomockctx/blob/main/LICENSE)