> For the complete documentation index, see [llms.txt](https://docs.b2winsuite.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.b2winsuite.com/5.2/scripting/static-classes/localdateutil.md).

# LocalDateUtil

`LocalDateUtil` provides utility methods for working with `LocalDate` objects. It includes methods for parsing, and extracting various date components.

### Methods

**`parseDate(dateStr: String, format: String): LocalDate`**

* Parses a date string using a custom format and returns a `LocalDate` object.
* Parameters:
  * `dateStr` (type: String) - The date string to parse.
  * `format` (type: String) - The custom date format pattern used for parsing.
* Returns:
  * A `LocalDate` object representing the parsed date.

```typescript
var dateStr = "2023-11-07";
var format = "yyyy-MM-dd";
var parsedDate = LocalDateUtil.parseDate(dateStr, format);
```

**`getYear(date: LocalDateTime): Integer`**

* Retrieves the year component of a `LocalDateTime` object.
* Parameters:
  * `date` (type: LocalDateTime) - The `LocalDateTime` object from which to extract the year.
* Returns:
  * An integer representing the year component.

```typescript
var dateTime = LocalDateTime.now();
var year = LocalDateUtil.getYear(dateTime);
```

**`getDayOfYear(date: LocalDate): Integer`**

* Retrieves the day of the year component of a `LocalDate` object.
* Parameters:
  * `date` (type: LocalDate) - The `LocalDate` object from which to extract the day of the year.
* Returns:
  * An integer representing the day of the year.

```typescript
var date = LocalDate.now();
var dayOfYear = LocalDateUtil.getDayOfYear(date);
```

**`getMonthName(date: LocalDate): String`**

* Retrieves the name of the month for a `LocalDate` object.
* Parameters:
  * `date` (type: LocalDate) - The `LocalDate` object from which to extract the month name.
* Returns:
  * A string representing the name of the month.

```typescript
var date = LocalDate.now();
var monthName = LocalDateUtil.getMonthName(date);
```

**`getMonth(date: LocalDate): Integer`**

* Retrieves the month component of a `LocalDate` object.
* Parameters:
  * `date` (type: LocalDate) - The `LocalDate` object from which to extract the month.
* Returns:
  * An integer representing the month.

```typescript
var date = LocalDate.now();
var month = LocalDateUtil.getMonth(date);
```

**`getDayOfWeek(date: LocalDate): String`**

* Retrieves the day of the week for a `LocalDate` object.
* Parameters:
  * `date` (type: LocalDate) - The `LocalDate` object from which to extract the day of the week.
* Returns:
  * A string representing the day of the week.

```typescript
var customDate = LocalDate.of(2023, 10, 24);
return LocalDateUtil.getDayOfWeek(customDate); // TUESDAY
```

**`getDayOfMonth(date: LocalDate): Integer`**

* Retrieves the day of the month component of a `LocalDate` object.
* Parameters:
  * `date` (type: LocalDate) - The `LocalDate` object from which to extract the day of the month.
* Returns:
  * An integer representing the day of the month.

```typescript
var date = LocalDate.now();
var dayOfMonth = LocalDateUtil.getDayOfMonth(date);
```

These methods provide various operations to work with `LocalDate` objects, including parsing date strings, and extracting individual date components.


---

# 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 dynamically by asking a question.

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

```
GET https://docs.b2winsuite.com/5.2/scripting/static-classes/localdateutil.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.