# `PgRest.Parser.Order`
[🔗](https://github.com/agoodway/pgrest/blob/v0.1.0/lib/pg_rest/parser/order.ex#L1)

Parses PostgREST order parameter into ordering directives.

Examples:
  - "created_at.desc.nullslast" -> [%{field: "created_at", direction: :desc, nulls: :last}]
  - "name.asc" -> [%{field: "name", direction: :asc, nulls: nil}]
  - "name" -> [%{field: "name", direction: :asc, nulls: nil}]

# `parse`

```elixir
@spec parse(String.t()) :: {:ok, [map()]}
```

Parses an order parameter string into a list of ordering directives.

Each directive contains `:field`, `:direction` (`:asc` or `:desc`),
and `:nulls` (`:first`, `:last`, or `nil`).

---

*Consult [api-reference.md](api-reference.md) for complete listing*