Skip to content

Commit

Permalink
Added quick note about where to import type definitions from (#232)
Browse files Browse the repository at this point in the history
  • Loading branch information
zacharytyhacz authored Oct 30, 2024
1 parent 41866bc commit 2113fc7
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,19 @@ Please refer to our [Getting Started Guide](https://docs.neynar.com/reference/ge

Checkout [examples](https://github.com/neynarxyz/farcaster-examples) using this SDK

## Type Definitions

You can directly import the type definitions from the SDK as shown below:

- See your `node_modules/@neynar/nodejs-sdk/build/neynar-api/v2/openapi-farcaster` directory for the type definitions.

```typescript
import { type User } from '@neynar/nodejs-sdk/build/neynar-api/v2/openapi-farcaster/models/user'
import { type CastAuthor } from '@neynar/nodejs-sdk/build/neynar-api/v2/openapi-farcaster/models/cast-author'
import { type CastWithInteractionsReactions } from '@neynar/nodejs-sdk/build/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-reactions'

```

## Contribution Guidelines

see [CONTRIBUTING.md](./CONTRIBUTING.md).
Expand Down

0 comments on commit 2113fc7

Please sign in to comment.