# provenanceComment

Source: /tuil/docs/reference/packages/registry/api/provenance-comment
Locale: en

function exported by @mwillbanks/tuil-registry.



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

## function [#function]

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

```ts
export function provenanceComment(item: RegistryItem, prefix = "//"): string;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member   | Type           | Required | Description                                  | Related types                                                         |
| -------- | -------------- | -------- | -------------------------------------------- | --------------------------------------------------------------------- |
| `item`   | `RegistryItem` | Yes      | Supplies the `item` value as `RegistryItem`. | [`RegistryItem`](/tuil/docs/reference/packages/registry/api/registry-item) |
| `prefix` | `unknown`      | No       | Supplies the `prefix` value as `unknown`.    | —                                                                     |

## Returns [#returns]

`string` — Returns a value that satisfies `string`.

Related types: —

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`RegistryItem`](/tuil/docs/reference/packages/registry/api/registry-item)

## Source [#source]

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

## Package [#package]

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