Skip to content

Commit

Permalink
Merge pull request #11 from deveeztech/doc/await-configuration
Browse files Browse the repository at this point in the history
Add confguration section for await package
  • Loading branch information
mmartinalo authored Aug 16, 2024
2 parents eefbb5a + 9ff659d commit db57306
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion pkg/await/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
To use this functionality in your code you only have to import the await package:

```go

package main

import(
Expand All @@ -20,9 +19,22 @@ func main() {

// your business logic here
}
```

Finally, to enable it you should use the following environment variable:
```bash
TILT_AWAIT_DEBUGGER_ENABLED=true
```

## Configuration

| Env var | Default | Description |
|---|---|---|
| TILT_AWAIT_POLLING_INTERVAL | 5 | Interval of time to check the connection for the port given |
| TILT_AWAIT_PORT_TO_LISTEN | 40000 | Port number to check the connection |




## How it works

Expand Down

0 comments on commit db57306

Please sign in to comment.