docs: defaultable tuple elements, fix some sidebar header links

arktypeio · Jan 4, 2025 · 283689e · 283689e
1 parent 8909026
commit 283689e
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 21 deletions.
diff --git a/ark/docs/content/docs/objects/arrays/meta.json b/ark/docs/content/docs/objects/arrays/meta.json
@@ -1,11 +1,11 @@
 {
 	"title": "arrays and tuples",
 	"pages": [
-		"lengths",
-		"[prefix](/docs/objects#arrays-prefix)",
-		"[optional](/docs/objects#arrays-optional)",
-		"[defaultable](/docs/objects#arrays-defaultable)",
-		"[variadic](/docs/objects#arrays-variadic)",
-		"[postfix](/docs/objects#arrays-postfix)"
+		"[lengths](/docs/objects#arrays-lengths)",
+		"[prefix](/docs/objects#tuples-prefix)",
+		"[defaultable](/docs/objects#tuples-defaultable)",
+		"[optional](/docs/objects#tuples-optional)",
+		"[variadic](/docs/objects#tuples-variadic)",
+		"[postfix](/docs/objects#tuples-postfix)"
 	]
 }
diff --git a/ark/docs/content/docs/objects/index.mdx b/ark/docs/content/docs/objects/index.mdx
@@ -623,19 +623,17 @@ const myTuple = type([
 
 ### defaultable [#tuples-defaultable]
 
-🚧 Coming soon ™️🚧
+Defaultable elements are optional elements that will be assigned their specified default if not present in the tuple's input.
 
-### optional [#tuples-optional]
+A tuple may include zero or more defaultable elements following its prefix elements and preceding its non-defaultable optional elements.
 
-Tuples can include any number of optional elements following its prefix elements.
-
-Like in TypeScript, optional elements are mutually exclusive with postfix elements.
+Like optional elements, defaultable elements are mutually exclusive with postfix elements.
 
 <SyntaxTabs>
 	<SyntaxTab string>
 
 ```ts
-const myTuple = type(["string", "boolean?", "number?"])
+const myTuple = type(["string", "boolean = false", "number = 0"])
 ```
 
     </SyntaxTab>
@@ -645,8 +643,8 @@ const myTuple = type(["string", "boolean?", "number?"])
 ```ts
 const myTuple = type([
 	type.string,
-	type.boolean.optional(),
-	type.number.optional()
+	type.boolean.default(false),
+	type.number.default(0)
 ])
 ```
 
@@ -661,24 +659,57 @@ const myTuple = type([
 		{
 			name: "string"
 		},
-		"?"
+		"=",
+		() => ({ name: "Anon Eemuss" })
 	]
 ])
 ```
 
     </SyntaxTab>
 
-    <SyntaxTab args>
+</SyntaxTabs>
+
+### optional [#tuples-optional]
+
+Optional elements are tuple elements that may or may not be present in the input that do not have a default value.
+
+A tuple may include zero or more optional elements following its prefix and defaultable elements and preceding either a variadic element or the end of the tuple.
+
+Like in TypeScript, optional elements are mutually exclusive with postfix elements.
+
+<SyntaxTabs>
+	<SyntaxTab string>
+
+```ts
+const myTuple = type(["string", "bigint = 999n", "boolean?", "number?"])
+```
+
+    </SyntaxTab>
+
+    <SyntaxTab fluent>
+
+```ts
+const myTuple = type([
+	type.string,
+	type.bigint.default(999n),
+	type.boolean.optional(),
+	type.number.optional()
+])
+```
+
+    </SyntaxTab>
+
+    <SyntaxTab tuple>
 
 ```ts
 const myTuple = type([
 	"string",
-	type(
+	[
 		{
 			name: "string"
 		},
 		"?"
-	)
+	]
 ])
 ```
 

diff --git a/ark/docs/content/docs/objects/properties/meta.json b/ark/docs/content/docs/objects/properties/meta.json
@@ -6,7 +6,7 @@
 		"[defaultable](/docs/objects#properties-defaultable)",
 		"[index](/docs/objects#properties-index)",
 		"[undeclared](/docs/objects#properties-undeclared)",
-		"[merge](/docs/objects#properties-merge)",
+		"[spread](/docs/objects#properties-spread)",
 		"[keyof](/docs/objects#properties-keyof)",
 		"[get](/docs/objects#properties-get)"
 	]

diff --git a/ark/type/parser/tupleExpressions.ts b/ark/type/parser/tupleExpressions.ts
@@ -157,6 +157,8 @@ export type TupleExpressionOperator = IndexZeroOperator | IndexOneOperator
 
 export type IndexOneOperator = TuplePostfixOperator | TupleInfixOperator
 
+export type ArgTwoOperator = Exclude<IndexOneOperator, "?" | "=">
+
 export type TuplePostfixOperator = "[]" | "?"
 
 export type TupleInfixOperator = "&" | "|" | "=>" | "=" | ":" | "@"

diff --git a/ark/type/type.ts b/ark/type/type.ts
@@ -29,7 +29,7 @@ import type { BaseType } from "./methods/base.ts"
 import type { instantiateType } from "./methods/instantiate.ts"
 import type { validateDeclared } from "./parser/definition.ts"
 import type {
-	IndexOneOperator,
+	ArgTwoOperator,
 	IndexZeroOperator,
 	TupleInfixOperator
 } from "./parser/tupleExpressions.ts"
@@ -70,7 +70,7 @@ export interface TypeParser<$ = {}> extends Ark.boundTypeAttachments<$> {
 		_1: zero extends "keyof" ? type.validate<one, $>
 		: zero extends "instanceof" ? conform<one, Constructor>
 		: zero extends "===" ? conform<one, unknown>
-		: conform<one, IndexOneOperator>,
+		: conform<one, ArgTwoOperator>,
 		..._2: zero extends "===" ? rest
 		: zero extends "instanceof" ? conform<rest, readonly Constructor[]>
 		: one extends TupleInfixOperator ?
@@ -187,9 +187,11 @@ export type DeclarationParser<$> = <preinferred>() => {
 }
 
 export type UnitTypeParser<$> = <const t>(value: t) => Type<t, $>
+
 export type InstanceOfTypeParser<$> = <const t extends object>(
 	ctor: Constructor<t>
 ) => Type<t, $>
+
 export type EnumeratedTypeParser<$> = <const values extends readonly unknown[]>(
 	...values: values
 ) => Type<values[number], $>