athena-express icon indicating copy to clipboard operation
athena-express copied to clipboard

parameter types of athena express query function don't seem to match documentation

Open mtin79 opened this issue 1 year ago • 1 comments

hi there, trying to use your example of a query config object as a parameter in the query function throws typescript errors! Screenshot 2022-09-14 at 10 37 50

Should i just ignore the typescript errors?

Also the documentation says that pagination format should be a string but examples are with numbers. Screenshot 2022-09-14 at 10 38 52

Thanks for help!!!

mtin79 avatar Sep 14 '22 08:09 mtin79

the other advanced query parameters are also missing. Until #89 is merged, you can create an augment.d.ts file in your project and paste the following content

declare module "athena-express" {
    interface QueryObjectInterface {
        db?: string
        pagination?: number
        NextToken?: string
        QueryExecutionId?: string
        catalog?: string
    }
}

export default {}

make sure to include the last line, otherwise you will not augment but override the typings.

romanlamsal avatar Oct 10 '22 09:10 romanlamsal