> For the complete documentation index, see [llms.txt](https://boxlang.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://boxlang.ortusbooks.com/boxlang-language/reference/components/debug/timer.md).

# Timer

Times a block of code and outputs the result in a specified format.

## Component Signature

```
<bx:Timer type=[string]
label=[string]
unit=[string]
variable=[string] />
```

### Attributes

| Atrribute  | Type     | Required | Description                                                                                  | Default |
| ---------- | -------- | -------- | -------------------------------------------------------------------------------------------- | ------- |
| `type`     | `string` | `false`  | The type of output to generate. One of `debug`, `comment`, `inline`, or `outline` or `dump`. |         |
| `label`    | `string` | `false`  | The label to use for the output.                                                             |         |
| `unit`     | `string` | `false`  | The unit of time to use for the output. One of `nano`, `micro`, `milli`, or `second`.        | `milli` |
| `variable` | `string` | `false`  | The name of the variable to store the result in.                                             |         |

## Examples

### Tag version

```java
<bx:timer label="Nap time" type="inline">
Begin some long running process ...
<bx:set sleep( 2000 ) >
done.
</bx:timer>
```

Result: The time elapsed while executing the code inside the <bx:timer> block should be displayed inline.

### Script version

[Run Example](https://try.boxlang.io/?code=eJxVjEEKwjAQRdfNKT6zqpsQXCrdeADv0OpQAulkSCaoiHc3dufq8x6PvzxPFjcuSPPCaaLrrPgJgr2UJ8rNUpSObzc8SjTuQpuNoAuvUVDzxkhZVpQmEvtqyTeuFd57EA5nN9TErCOOIYSd%2F3%2FuWdjv4cd9AXLfLXM%3D)

```java
bx:timer label="Nap time" type="outline" {
	writeoutput( "Begin some long running process ... " );
	sleep( 2000 );
	writeoutput( "done." );
}

```

Result: The time elapsed while executing the code inside the bx:timer block should be displayed in the output with an outline around any output generated within the bx:timer call..


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://boxlang.ortusbooks.com/boxlang-language/reference/components/debug/timer.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.