What to do when types are not exported from npm module | TypeScript Community | Page 1

torpid wagon Jun 9, 2023, 1:25 AM

#

I have some code:

 await db.transaction(async (trx) => {
  ...
})

inside of that block i need to pass trx to functions, i do so like this:

            const items = await Items.fetchAll({ trx })

sometimes like in this case its totally fine.

static async fetchAll ({ trx = db }): Promise<Array<any>> {
  ...
}

in cases where i type the destructure like so:

static async updateCharacterEquipment ({ character, items, charID, incursionID, trx = db } : { character : Character, items : Array<Item>, charID : number, incursionID : number, trx : any }): Promise<void> {
  ...
}

I get errors:
character/index.character.ts(59,38): error TS7006: Parameter 'trx' implicitly has an 'any' type.
character/index.character.ts(58,46): error TS7031: Binding element 'character' implicitly has an 'any' type.
character/index.character.ts(58,57): error TS7031: Binding element 'items' implicitly has an 'any' type.
character/index.character.ts(58,64): error TS7031: Binding element 'charID' implicitly has an 'any' type.
character/index.character.ts(58,72): error TS7031: Binding element 'incursionID' implicitly has an 'any' type.

Not sure how to handle these errors, and i dont know how to get the Knex.Transaction type so that I can properly type the trx

worn hinge Jun 9, 2023, 2:12 AM

#

you shouldn't use any to begin with

torpid wagon Jun 9, 2023, 2:12 AM

#

I dont want to use any

worn hinge Jun 9, 2023, 2:12 AM

#

you're using it in updateCharacterEquipment

torpid wagon Jun 9, 2023, 2:12 AM

#

i understand

#

I have to to get the errors to go away

#

because Knex.Transaction, the type of trx, is not exported from the knex module

#

so i have no way to type it

worn hinge Jun 9, 2023, 2:13 AM

#

the errors are on separate lines but the code you showed seems to all be on the same line?

#

im confused

#

can you make an example in the playground?

torpid wagon Jun 9, 2023, 2:14 AM

#

    static async updateCharacterEquipment ({ character, items, charID, incursionID, trx = db } : { character : Character, items : Array<Item>, charID : number, incursionID : number, trx : any }): Promise<void> {
        return trx.transaction(async trx => {
            ...
        })
    }

the part where i am returning the trx is the part throwing the error

#

because it doesnt know what trx is

#

lol

worn hinge Jun 9, 2023, 2:15 AM

#

it's the parameter in the callback that's erroring there

#

there's no type for it

#

that's why it implicitly has an any type there

torpid wagon Jun 9, 2023, 2:16 AM

#

Right, its of type Knex.Transaction, but I dont have the ability to tell it that

#

which is what id like to do

worn hinge Jun 9, 2023, 2:21 AM

#

it is exported though

#

you can import it and give it that typing

#

https://github.com/knex/knex/blob/master/types/index.d.ts#L2320

analog laurelBOT Jun 9, 2023, 2:21 AM

#

interface Transaction<TRecord extends {} = any, TResult = any[]>

worn hinge Jun 9, 2023, 2:22 AM

#

https://github.com/knex/knex/blob/master/types/index.d.ts#L489

analog laurelBOT Jun 9, 2023, 2:22 AM

#

export declare namespace knex {

worn hinge Jun 9, 2023, 2:22 AM

#

it's exported under the namespace

#

wrong line, edited in the message but hte bot preview isn't edited

torpid wagon Jun 9, 2023, 2:23 AM

#

hmmm

#

i have been trying

#

can you show me how to?

#

i tried importing knex then doing knex.Trasnasction with no luck

worn hinge Jun 9, 2023, 2:24 AM

#

not confident about importing namespaces, but it should be something like this i believe

import type { Knex } from "knex";
type Transaction = Knex.Transaction; // or consume elsewhere

worn hinge Jun 9, 2023, 2:24 AM

#

torpid wagon i tried importing knex then doing knex.Trasnasction with no luck

the namespace is in PascalCase.

kindred hawkBOT Jun 9, 2023, 2:25 AM

#

that_guy977#0

Playground Link

Preview:```ts
import type {Knex} from "knex"
type Transaction<
TRecord extends {} = any,
TResult = any[]

= Knex.Transaction<TRecord, TResult> // or consume elsewhere
// ^?
type X = Transaction["transaction"]
// ^?```

worn hinge Jun 9, 2023, 2:26 AM

#

all the appropriate types applied

torpid wagon Jun 9, 2023, 2:28 AM

#

hell yes i had never seen import type { Knex } from "knex"; before importing types

#

is there a way for me to do that in my code, do you have documentation for that?

worn hinge Jun 9, 2023, 2:28 AM

#

import { Knex } from "knex" also works, this is just being explicit about it being a type

worn hinge Jun 9, 2023, 2:29 AM

#

torpid wagon is there a way for me to do that in my code, do you have documentation for that?

um. just use the code i showed...?

torpid wagon Jun 9, 2023, 2:29 AM

#

i was doing import Knex from "knex"

worn hinge Jun 9, 2023, 2:29 AM

#

that accesses the default export, not named exports

torpid wagon Jun 9, 2023, 2:29 AM

#

i see i see

worn hinge Jun 9, 2023, 2:29 AM

#

https://justlink.to/mdn/import check that

import - JavaScript | MDN

The static import declaration is used to import read-only live bindings which are exported by another module. The imported bindings are called live bindings because they are updated by the module that exported the binding, but cannot be re-assigned by the importing module.

torpid wagon Jun 9, 2023, 2:30 AM

#

yeah that makse sense for a sec i thought it was some kind of typescript specific import

#

but that makes sense

#

thank you

worn hinge Jun 9, 2023, 2:30 AM

#

ts adds type imports in the form import type { T, U } or import { type T, value } (and similar alternatives)

#

they're just for clarity

torpid wagon Jun 9, 2023, 2:31 AM

#

yeah im definitely going to me using more named exports in that fashion

worn hinge Jun 9, 2023, 2:31 AM

#

or they omit importing the class if the given type is from a class

torpid wagon Jun 9, 2023, 2:31 AM

#

I see gotcha

worn hinge Jun 9, 2023, 2:31 AM

#

typescript handbook for modules, section about type imports
https://www.typescriptlang.org/docs/handbook/modules.html#importing-types

torpid wagon Jun 9, 2023, 2:32 AM

#

thats dope thanks ill read that

#

also 1 more question, do you know how to type objects created with the spread operator like so:

static async addEvent ({ incursionID, eventType, trx = db, ...params } : { incursionID : number, eventType : string, trx: any })

dunno how to type ...params

worn hinge Jun 9, 2023, 2:33 AM

#

you don't

#

params is just everything else on the object that hasn't been destructured

#

that's how it's typed

#

you haven't specified any extra props that haven't been specified there so params is just {}

torpid wagon Jun 9, 2023, 2:34 AM

#

when i call it i do pass more stuff in

#

was using it to create a generic object of junk that i pass in based on eventtype

#

await IncursionLog.addEvent({ trx, incursionID, eventType: IncursionLog.EVENT_TYPES.ITEM_PICKUP_SUCCESS, item, equipmentSlot: 'Backpack' })

worn hinge Jun 9, 2023, 2:36 AM

#

you'd make the function generic over IncursionLog.EVENT_TYPES then

torpid wagon Jun 9, 2023, 2:36 AM

#

yeeeee that sounds good, ill do that, im translating this to ts from a js so there will be fstuff like that i gota do

worn hinge Jun 9, 2023, 2:36 AM

#

then you could add types for that to the parameter

#

(why's IncursionLog.EVENT_TYPES in MACRO_CASE btw. that isn't a constant, that looks to be more of an enum
a container for constants is not itself a constant
)

torpid wagon Jun 9, 2023, 2:38 AM

#

yeah its an enum

worn hinge Jun 9, 2023, 2:38 AM

#

enums should be PascalCase

torpid wagon Jun 9, 2023, 2:38 AM

#

my standard was to use caps like that for enums when i was doing JS, now ill probably convert it to a TS enum and pascal it

#

yeah

#

im still just trying to get this thing to compile since the swapover

worn hinge Jun 9, 2023, 2:40 AM

#

you might want to turn off noImplicitAny and maybe strict for the time being
you aren't going to get type safety for a while so just embrace the lack of it while translating

#

any is commonly used in the process of translation

#What to do when types are not exported from npm module