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.

Sign up for GitHub

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

Jump to bottom

Help Wanted: Completing the API Reference on Website #287

Open
fabian-hiller opened this issue Dec 7, 2023 · 39 comments · May be fixed by #810
Open

Help Wanted: Completing the API Reference on Website #287

fabian-hiller opened this issue Dec 7, 2023 · 39 comments · May be fixed by #810
Assignees
@fabian-hiller
Labels
documentation Improvements or additions to documentation priority This has priority

Comments

@fabian-hiller
Copy link
Owner

fabian-hiller commented Dec 7, 2023 •
edited
Loading

Important

The following description is outdated. All synchronous APIs are already fully documented. We are just missing a few asyncronous APIs. If you still want to help, feel free to comment below.

This issue is used to coordinate the expansion of our API reference. The first reference was created by @kazizi55 in #220. Please use the already added references as a template. You can also use this issue if you encounter problems or have questions.

If you are interested in helping us extend the API reference, please add a comment to this issue with the API you want to take over. I will summarize the current state in the tables below.

Schemas
API Author Pull Request Merged
any @fabian-hiller - ✅
array @kazizi55 #330 ✅
bigint @fabian-hiller - ✅
blob @fabian-hiller - ✅
boolean @wout-junius #316 ✅
date @wout-junius #315 ✅
enum_ @fabian-hiller - ✅
instance @fabian-hiller - ✅
intersect @fabian-hiller - ✅
literal @fabian-hiller - ✅
map @fabian-hiller - ✅
nan @fabian-hiller - ✅
never @fabian-hiller - ✅
nonNullable @fabian-hiller - ✅
nonNullish @fabian-hiller - ✅
nonOptional @fabian-hiller - ✅
null_ @fabian-hiller - ✅
nullable @sqmasep #328 ✅
nullish @sqmasep #329 ✅
number @kazizi55 #331 ✅
object @kazizi55 #357 ✅
optional @sqmasep #321 ✅
picklist @sqmasep #312 ✅
record @fabian-hiller - ✅
recursive @fabian-hiller - ✅
set @fabian-hiller - ✅
special @fabian-hiller - ✅
string @kazizi55 #220 ✅
symbol @wout-junius #317 ✅
tuple @fabian-hiller - ✅
undefined_ @fabian-hiller - ✅
union @fabian-hiller - ✅
unknown @mwskwong #365 ✅
variant @fabian-hiller - ✅
void_ @fabian-hiller - ✅
Methods
API Author Pull Request Merged
brand @fabian-hiller - ✅
coerce @fabian-hiller - ✅
fallback @sqmasep #337 ✅
forward @fabian-hiller - ✅
getDefault @fabian-hiller - ✅
getDefaults @fabian-hiller - ✅
getFallback @fabian-hiller - ✅
getFallbacks @fabian-hiller - ✅
is @fabian-hiller - ✅
keyof @fabian-hiller - ✅
merge @fabian-hiller - ✅
omit @fabian-hiller - ✅
parse @fabian-hiller - ✅
partial @fabian-hiller - ✅
pick @fabian-hiller - ✅
required @fabian-hiller - ✅
safeParse @fabian-hiller - ✅
transform @fabian-hiller - ✅
unwrap @fabian-hiller - ✅
Validations
API Author Pull Request Merged
bic @ariskemper #386 ✅
bytes @fabian-hiller - ✅
creditCard @ariskemper #388 ✅
cuid2 @fabian-hiller - ✅
custom @fabian-hiller - ✅
decimal @fabian-hiller - ✅
email @fabian-hiller - ✅
emoji @fabian-hiller - ✅
endsWith @fabian-hiller - ✅
every @fabian-hiller - ✅
excludes @fabian-hiller - ✅
finite @fabian-hiller - ✅
hash @ariskemper #392 ✅
hexadecimal @ariskemper #414 ✅
hexColor @ariskemper #401 ✅
iban @ariskemper
imei @fabian-hiller - ✅
includes @fabian-hiller - ✅
integer @fabian-hiller - ✅
ip @fabian-hiller - ✅
ipv4 @fabian-hiller - ✅
ipv6 @fabian-hiller - ✅
isoDate @fabian-hiller - ✅
isoDateTime @fabian-hiller - ✅
isoTime @fabian-hiller - ✅
isoTimeSecond @fabian-hiller - ✅
isoTimestamp @fabian-hiller - ✅
isoWeek @fabian-hiller - ✅
length @fabian-hiller - ✅
mac @ariskemper #407 ✅
mac48 @ariskemper #407 ✅
mac64 @ariskemper #407 ✅
maxBytes @fabian-hiller - ✅
maxLength @fabian-hiller
maxSize @fabian-hiller - ✅
maxValue @fabian-hiller - ✅
mimeType @fabian-hiller - ✅
minBytes @fabian-hiller - ✅
minLength @fabian-hiller
minSize @fabian-hiller - ✅
minValue @fabian-hiller - ✅
multipleOf @fabian-hiller - ✅
notBytes @fabian-hiller - ✅
notLength @fabian-hiller - ✅
notSize @fabian-hiller - ✅
notValue @fabian-hiller - ✅
octal @ariskemper #415 ✅
regex @fabian-hiller - ✅
safeInteger @fabian-hiller - ✅
size @fabian-hiller - ✅
some @fabian-hiller - ✅
startsWith @fabian-hiller - ✅
ulid @fabian-hiller - ✅
url @fabian-hiller - ✅
uuid @fabian-hiller - ✅
value @fabian-hiller - ✅
Transformations
API Author Pull Request Merged
toCustom @fabian-hiller
toLowerCase @fabian-hiller
toMaxValue @fabian-hiller
toMinValue @fabian-hiller
toTrimmed @fabian-hiller
toTrimmedEnd @fabian-hiller
toTrimmedStart @fabian-hiller
toUpperCase @fabian-hiller
Error
API Author Pull Request Merged
flatten @fabian-hiller
ValiError @fabian-hiller
Async
API Author Pull Request Merged
anyAsync
arrayAsync
bigintAsync
blobAsync
booleanAsync
coerceAsync
customAsync
dateAsync
enumAsync
fallbackAsync
forwardAsync
getDefaultAsync
getDefaultsAsync
getFallbackAsync
getFallbacksAsync
instanceAsync
intersectAsync
literalAsync
mapAsync
mergeAsync
nanAsync
neverAsync
nonNullableAsync
nonNullishAsync
nonOptionalAsync
nullableAsync
nullishAsync
nullAsync
numberAsync
objectAsync
omitAsync
optionalAsync
parseAsync
partialAsync
pickAsync
picklistAsync
recordAsync
recursiveAsync
requiredAsync
safeParseAsync
setAsync
specialAsync
stringAsync
symbolAsync
toCustomAsync
transformAsync
tupleAsync
undefinedAsync
unionAsync
unknownAsync
variantAsync
voidAsync
@fabian-hiller fabian-hiller added documentation Improvements or additions to documentation priority This has priority labels Dec 7, 2023
@fabian-hiller fabian-hiller self-assigned this Dec 7, 2023
@fabian-hiller fabian-hiller mentioned this issue Dec 7, 2023
Closed
@kazizi55
Copy link
Contributor

@fabian-hiller
Hi! To begin with, I'd like to take over array , number and object! 😄

@wout-junius
Copy link
Contributor

@fabian-hiller I do not mind beginning on the date, boolean, and symbol! :D

@fabian-hiller
Copy link
Owner Author

Thank you guys! I updated the tables.

@ariskemper
Copy link
Contributor

@fabian-hiller please update table for bic, mac, mac48, mac64, and include me.

@fabian-hiller fabian-hiller mentioned this issue Dec 21, 2023
Merged
@sqmasep
Copy link
Contributor

sqmasep commented Dec 22, 2023

@fabian-hiller Hi! I'll work on documenting fallback, getFallback, getFallbacks, getDefault, getDefaults, optional, nullish, & nullable, you can update the table 😉

This was referenced Dec 22, 2023
Merged
Merged
Merged
fabian-hiller added a commit that referenced this issue Dec 28, 2023
@fabian-hiller
Add link to issue #287 for each missing API reference
521c128
This was referenced Dec 28, 2023
Merged
Merged
This was referenced Dec 29, 2023
Merged
Merged
@sqmasep sqmasep mentioned this issue Dec 29, 2023
Merged
@kazizi55
Copy link
Contributor

kazizi55 commented Jan 3, 2024

@fabian-hiller
Happy new year 2024! 😄
I'd like to take over is, keyof, merge, and omit!

@fabian-hiller
Copy link
Owner Author

Happy new new year and thank you! I will update the tables.

@kazizi55 kazizi55 mentioned this issue Jan 8, 2024
Merged
@fabian-hiller fabian-hiller pinned this issue Jan 14, 2024
@fabian-hiller fabian-hiller changed the title Coordination for extension of the API reference Coordination for extension of the API reference [Help Wanted][Documentation] Completing the API Reference Jan 14, 2024
@fabian-hiller fabian-hiller changed the title Coordination for extension of the API reference [Help Wanted][Documentation] Completing the API Reference Help Wanted: Completing the API Reference Jan 14, 2024
@fabian-hiller fabian-hiller changed the title Help Wanted: Completing the API Reference Help Wanted: Completing the API Reference on Website Jan 14, 2024
@mwskwong
Copy link
Contributor

mwskwong commented Jan 14, 2024 •
edited
Loading

Edit: NVM, I underestimated the difficulties of nonNullable. Let me try unknown() first

@mwskwong mwskwong mentioned this issue Jan 14, 2024
Merged
@fabian-hiller
Copy link
Owner Author

fabian-hiller commented Jan 16, 2024 •
edited
Loading

I will take the rest of the API reference (except the async APIs) and finish them by the end of the month. You can still help by copying the reference of an already added sync API and adding its async reference. Just send here the async APIs you want to work on and I will add your username to the table.

@Talent30 Talent30 mentioned this issue Jan 27, 2024
Closed
@EltonLobo07
Copy link
Contributor

@fabian-hiller I would like to work on documenting objectAsync, checkAsync and setAsync next.

@fabian-hiller
Copy link
Owner Author

Yes, thank you!

@EltonLobo07
Copy link
Contributor

@fabian-hiller I would like to work on documenting awaitAsync, fallbackAsync, forwardAsync, getDefaultsAsync, and getFallbacksAsync next.

@fabian-hiller
Copy link
Owner Author

Go ahead 🙏

@mehm8128
Copy link
Contributor

@fabian-hiller Hi, I would like to work on documenting tupleAsync.

@fabian-hiller
Copy link
Owner Author

Yes, thank you!

@mehm8128 mehm8128 mentioned this issue Jul 23, 2024
Merged
@fabian-hiller
Copy link
Owner Author

@mehm8128 feel free to also work on looseTupleAsync, tupleWithRestAsync and strictTupleAsync.

@mehm8128
Copy link
Contributor

I'll challenge it on another day🙌

This was referenced Jul 23, 2024
Merged
Merged
Merged
@EltonLobo07
Copy link
Contributor

EltonLobo07 commented Jul 27, 2024 •
edited
Loading

@fabian-hiller I would like to work on documenting intersectAsync, lazyAsync, looseObjectAsync, nonNullableAsync, nonNullishAsync, nonOptionalAsync, strictObjectAsync, and objectWithRestAsync next.

@fabian-hiller
Copy link
Owner Author

Thank you!

@santoshyadavdev
Copy link
Contributor

Hey @fabian-hiller ,

I will take Transformations APIs.

@EltonLobo07
Copy link
Contributor

@fabian-hiller, I would like to work on documenting parseAsync, parserAsync, unionAsync and variantAsync next.

@fabian-hiller
Copy link
Owner Author

Thank you both!

@fabian-hiller
Copy link
Owner Author

@santoshyadavdev any updates?

@EltonLobo07
Copy link
Contributor

@fabian-hiller I would like to work on documenting partialCheckAsync, pipeAsync, safeParseAsync and safeParserAsync next.

@fabian-hiller
Copy link
Owner Author

Thank you @EltonLobo07!

@santoshyadavdev santoshyadavdev mentioned this issue Aug 24, 2024
Closed
@santoshyadavdev
Copy link
Contributor

@fabian-hiller I see some of them are already documented under actions

@fabian-hiller
Copy link
Owner Author

fabian-hiller commented Aug 25, 2024 •
edited
Loading

Yes, unfortunately I stopped updating the table due to time constraints after finishing all the sync API references. Now only a few async references are missing.

These are still missing: nullableAsync, nullishAsync, optionalAsync, partialAsync, partialCheckAsync, rawCheckAsync, rawTransformAsync, recordAsync, requiredAsync and transformAsync.

@santoshyadavdev
Copy link
Contributor

no worries i will open another PR

@santoshyadavdev
Copy link
Contributor

santoshyadavdev commented Sep 1, 2024 •
edited
Loading

@fabian-hiller I tried to serve the app locally and getting this error, do you know how to fix it

Screenshot 2024-09-01 at 15 39 39 Screenshot 2024-09-01 at 15 42 28

@fabian-hiller
Copy link
Owner Author

Yes, I think you need to build the library first: cd ./library && pnpm build

@EltonLobo07
Copy link
Contributor

@fabian-hiller I would like to work on documenting partialAsync, rawCheckAsync, recordAsync, and requiredAsync. @santoshyadavdev Can you let us know which APIs you are planning on documenting? So that we can eliminate the possibility of documenting the same APIs. Also, here is the updated missing list: nullableAsync, nullishAsync, optionalAsync, rawTransformAsync, transformAsync, and undefinedableAsync.

@santoshyadavdev santoshyadavdev linked a pull request Sep 1, 2024 that will close this issue
Draft
@santoshyadavdev
Copy link
Contributor

@EltonLobo07 I started #810 documenting

nullableAsync, nullishAsync go ahead wit partialAsync, rawCheckAsync, recordAsync, and requiredAsync I will remove them from my PR

@fabian-hiller fabian-hiller unpinned this issue Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fabian-hiller fabian-hiller

Labels
documentation Improvements or additions to documentation priority This has priority
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: document async apis - IN-PROGRESS santoshyadavdev/valibot
10 participants
@ariskemper @santoshyadavdev @wout-junius @mwskwong @fabian-hiller @kazizi55 @EltonLobo07 @sakupi01 @sqmasep @mehm8128