From 2113fc748a20241a0310fa495b8faca89c1a263f Mon Sep 17 00:00:00 2001 From: zac <38140593+zacharytyhacz@users.noreply.github.com> Date: Wed, 30 Oct 2024 15:38:21 -0400 Subject: [PATCH] Added quick note about where to import type definitions from (#232) --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 05e8b052..bb747fb8 100644 --- a/README.md +++ b/README.md @@ -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).