ServerConfig.d.ts: add types for options #7328
Conversation
Add some types for the options in ServerConfig. This uncovered a missing check in sendFeedback.
| declare class ServerConfig { | ||
| config: unknown; | ||
| init(serverConfigUrl: string): Promise<unknown>; | ||
| config: ServerConfigOptions; |
There was a problem hiding this comment.
It's not for this PR, but I find the ServerConfig design a bit puzzling, the object caches a configuration, but ServerConfig.init() that uses the cached configuration is only called from Terria.start(), and that call is always done directly after new ServerConfig(). To me, it seems it would have been easier to have ServerConfig.init() be the equivalent of a static function in other languages so ServerConfig object would never have to be allocated at all.
There was a problem hiding this comment.
This way server endpoint will be called only once, or do you mean about the server config stored in the terria class?
| @@ -167,7 +167,7 @@ export interface ConfigParameters { | |||
| * @deprecated | |||
| */ | |||
| proxyableDomainsUrl?: string; | |||
| serverConfigUrl?: string; | |||
| serverConfigUrl: string; | |||
There was a problem hiding this comment.
I believe serverConfigUrl should be optional as it's non-required property, and terria can work without having terriajs-server
| newShareUrlPrefix?: string; | ||
| shareUrlPrefixes: object; | ||
| additionalFeedbackParameters: object[]; | ||
| } |
There was a problem hiding this comment.
p.s. It might be better to define this interface in terriajs-server, but from the top of my head, I am not sure if it is possible.
| shareUrlPrefixes: object; | ||
| additionalFeedbackParameters: object[]; | ||
| } | ||
|
|
||
| declare class ServerConfig { |
There was a problem hiding this comment.
What do you think about converting the entire ServerConfig class to typescript? it is relatively small and it would be easier then to have an additional declaration file
| declare class ServerConfig { | ||
| config: unknown; | ||
| init(serverConfigUrl: string): Promise<unknown>; | ||
| config: ServerConfigOptions; |
There was a problem hiding this comment.
This way server endpoint will be called only once, or do you mean about the server config stored in the terria class?
What this PR does
Add some types for the options in
ServerConfig. This uncovered a missing
check in sendFeedback.
Test me
Tested by CI.
Checklist
doc/.