# @clipprjs/lexicons

Lexicon package auto-generated with `@atcute/lex-cli`

> This package is *somewhat* unstable. Lexicon attributes can be modified at any moment.
> Please do not use this package for anything until the [Clippr server](https://tangled.sh/@hexmani.ac/clippr) has been
> deployed for either public or developer usage.

## Usage

> This section has been shamelessly lifted from
> the [atcute definitions](https://github.com/mary-ext/atcute/tree/trunk/packages/definitions/bluesky) packages. We
> recommend using this package with other atcute libraries for maximum compatibility.

```ts
import {SocialClipprFeedClip} from '@clipprjs/lexicons';
import {is} from '@atcute/lexicons';

const record: SocialClipprFeedClip.Main = {
    $type: 'social.clippr.feed.clip',
    createdAt: "2025-07-08T12:34:56.123Z",
    url: "https://example.com",
    title: "Example page",
    description: "Example description",
    unlisted: false,
    notes: "This is an example note for a clip",
    tags: undefined,
    unread: true,
    languages: [
        "en"
    ]
};

is(SocialClipprFeedClip.mainSchema, record);
// -> true
```

### Using with `@atcute/client`

Pick either one of these three options to register the ambient declarations:

```jsonc
// tsconfig.json
{
	"compilerOptions": {
		"types": ["@clipprjs/lexicons"],
	},
}
```

```ts
// env.d.ts
/// <reference types="@clipprjs/lexicons" />
```

```ts
// index.ts
import type {} from '@clipprjs/lexicons';
```

All the XRPC operations should be visible in the client afterward.