# parseSgrPointer

Source: /tuil/docs/reference/packages/pointer/api/parse-sgr-pointer
Locale: en

function exported by @mwillbanks/tuil-pointer.



{/* Generated by tooling/docs/generate-reference.ts. */}

## function [#function]

Public function exported by `@mwillbanks/tuil-pointer`.

```ts
export function parseSgrPointer(input: string): ParsedPointerInput | undefined;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member  | Type     | Required | Description                             | Related types |
| ------- | -------- | -------- | --------------------------------------- | ------------- |
| `input` | `string` | Yes      | Supplies the `input` value as `string`. | —             |

## Returns [#returns]

`ParsedPointerInput | undefined` — Returns a value that satisfies `ParsedPointerInput | undefined`.

Related types: [`ParsedPointerInput`](/tuil/docs/reference/packages/pointer/api/parsed-pointer-input)

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`ParsedPointerInput`](/tuil/docs/reference/packages/pointer/api/parsed-pointer-input)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/pointer/src/index.ts)

## Package [#package]

[@mwillbanks/tuil-pointer](/tuil/docs/reference/packages/pointer)