Allow customization of prop serialization/hydration by supplying custom ser/des functions
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- deno, typescript
- Domain
- backend-api-design
Research direction
Start by tracing how Fresh serializes and hydrates props for island components; the issue does not name files or tests, so locate those entry points in the repository. Then assess where custom handlers could be registered and applied, using the Temporal polyfill example as context. Done means island props can round-trip supported custom types through serialization and hydration.
Written by the indexing model from the issue text.
Description
Example:
type CustomPropTypeHandler<T, S extends JsonSerializableValue> {
is(x: unknown): x is T
serialize(x: T): S
hydrate(serialized: S): T
}
// prop type I want to make serializable
class Foo {
constructor(public readonly bar: string) {}
}
// handler
const fooPropTypeHandler: CustomPropTypeHandler<Foo, string> = {
is: (x) => x instanceof Foo,
serialize: (x) => x.bar,
hydrate: (bar) => new Foo(bar),
}
// middleware
app.use((ctx) => {
ctx.customPropTypeHandlers.push(fooPropTypeHandler)
})
// island component
export function FancyDiv(foo: Foo) {
<div>{foo.bar}</div>
}
// server-side component/page
<FancyDiv foo={new Foo('hello world')} />
This probably wouldn't make much sense for mutable data, but it'd allow passing around richer data types. It could even work for stringified functions, with the caveat that there'd be footguns, which is less of an issue if it's a userland solution rather than officially supported.
My current, significantly less footgun-prone use case is that I want to add ser/des support for polyfilled Temporal classes.
- Dominant language
- TypeScript
- Stars
- 13.8k
- Forks
- 757
- Avg merge
- 3m
- Merged PRs (30d)
- 2
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from freshframework/fresh
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
freshframework/fresh#3920 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
freshframework/fresh#3833 ·
-
feat
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
freshframework/fresh#3803 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 10/100
freshframework/fresh#3918 · 1 comment · 4 reactions ·
-
Tab title doesn't update to <Head> <title> when navigating to a page with another <title>Possibly taken @1AbdullahButt claimed this 7 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 57/100
freshframework/fresh#3916 ·
All issues in freshframework/fresh
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
tintinweb/pi-subagents#459 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
danielmiessler/LifeOS#2830 ·
Maintainers usually reply within 6 days
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
area: client enhancement priority: low
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
opensro-dev/opensro#3681 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day