Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix SerializerCompiler type #48

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

remidewitte
Copy link

@remidewitte remidewitte commented Apr 3, 2024

PR for #47 .

A reflexion is that RouteDefinition could rather be because in the context of the compiler I think the compiler would never be called if the schema is undefined and most of the time url, method and httpStatus are not used :

export type RouteDefinition = {
    method?: string;
    url?: string;
    httpStatus?: string;
    schema: unknown;
  }

And if used with reply.getSerializationFunction or reply.compileSerializationSchema they can be undefined :

.getSerializationFunction(schema | httpStatus, [contentType]) - Returns the serialization function for the specified schema or http status, if any of either are set.
.compileSerializationSchema(schema, [httpStatus], [contentType]) - Compiles the specified schema and returns a serialization function using the default (or customized) SerializerCompiler. The optional httpStatus is forwarded to the SerializerCompiler if provided, default to undefined.

What do you think ?

Checklist

@Eomm Eomm linked an issue Apr 3, 2024 that may be closed by this pull request
2 tasks
Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Is type SerializerCompiler correct ?
3 participants