SolidJS•12mo ago

declare types for locals?

i need to declare some locals for RequestEvent

import { User } from "lucia";

declare module "@solidjs/start" {
  export interface RequestEventLocals {
    user?: User;
  }
}

import { User } from "lucia";

declare module "@solidjs/start" {
  export interface RequestEventLocals {
    user?: User;
  }
}

that didn't work

6 Replies

peerreynders•12mo ago

- Where did you place this declaration? - How exactly did “that didn't work” manifest itself?

HusseinOP•12mo ago

- src/global.d.ts - it didn't show in vscode suggestions in getRequestEvent()?.locals

peerreynders•12mo ago

I threw mine into entry-server.tsx and neovim's LSP never complained about it.

GitHub

solid-start-sse-chat/src/entry-server.tsx at d2b9070f956947c940dc20...

Basic Chat demonstration with server-sent events (SSE) - peerreynders/solid-start-sse-chat

HusseinOP•12mo ago

oh ok i needed @solidjs/start/server i was using @solidjs/start here ^

peerreynders•12mo ago

Details do matter

slim (jamesc)•2mo ago

For me VSCodium [code] does not find my own RequestEventLocals. I have made many "guesses." F12 on event.locals takes me to @solidjs/start/dist/server/types.d.ts, but F12 on event.locals.myVar it takes me to @solidjs/start/env.d.ts where that definition allows any string [key: string | symbol]: any; even though I have myVar defined just like you have user defined above.. Maybe having the declaration in entry-server works for the build, but I'm not sure how that will work for the editor at the same time; that does not seam like an entry point that VSCodium can pick up on. I tried various things using tsconfig.ts but I'm just not having any luck, there is a lack of clarity in the ts docs and lack of feedback from the tools. Here is how vite does it: https://vite.dev/guide/env-and-mode#intellisense-for-typescript .. That does work in VSCodium. They direct the end-user to create vite-env.d.ts which has /// <reference types="vite/client" /> at the top. I do not see any special code to load vite-env.d.ts in their github repo. Maybe VSCodium scans ./src for *.d.ts files? I do have "include": ["src"] and compilerOptions.types: ['src/global'] in my tsconfig.js (I guess one of those helps). If that is the case then the declare above should work; but it does not. Maybe solid's [key: string | symbol]: any; is interfering and capturing the search before it gets to the custom types? I'm pretty sure this works for everyone else but me .. lol

Gaming

Programming

declare types for locals?

Did you find this page helpful?