# Param

Tests for a parameter's existence, tests its data type, and, if a default value is not assigned, optionally provides one.

## Component Signature

```
<bx:Param name=[string]
type=[string]
default=[any]
max=[numeric]
min=[numeric]
pattern=[string] />
```

### Attributes

| Atrribute | Type      | Required | Description                        | Default |
| --------- | --------- | -------- | ---------------------------------- | ------- |
| `name`    | `string`  | `true`   | The name of the parameter          |         |
| `type`    | `string`  | `false`  | The data type of the parameter     |         |
| `default` | `any`     | `false`  | The default value of the parameter |         |
| `max`     | `numeric` | `false`  | The maximum value of the parameter |         |
| `min`     | `numeric` | `false`  | The minimum value of the parameter |         |
| `pattern` | `string`  | `false`  | The pattern of the parameter       |         |

## Examples

### bx:param in BL

A very basic BL bx:param example

```java
<bx:param name="userID" default="0"/>
```

### bx:param in script

A very basic script bx:param example

[Run Example](https://try.boxlang.io/?code=eJxLqrAqSCxKzFXIS8xNtVUqLU4t8nRRUkhJTUsszSmxNbDmSiKoAgArtxbV)

```java
bx:param name="userID" default=0;
bx:param name="userID" default=0;

```

### Tag syntax using a regex

Throws an error if the value is not one of a list of possible values

```java
<bx:param name="sortdir" default="ASC" type="regex" pattern="ASC|DESC"/>
```


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://boxlang.ortusbooks.com/boxlang-language/reference/components/system/param.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.