Merge pull request #836 from processing/rest-types

Support rest types in Syntax section of reference

Author: davepagurek

src/components/MethodSignature/index.astro

@@ -14,8 +14,13 @@ import { CopyCodeButton } from "../CopyCodeButton";
 
 const { params, name, overloads } = Astro.props;
 
-const formatParam = (param: ReferenceParam) =>
-  param.optional ? `[${param.name}]` : `${param.name}`;
+const formatParam = (param: ReferenceParam) => {
+  let formatted = param.optional ? `[${param.name}]` : `${param.name}`;
+  if (param.rest) {
+    formatted = `${param.name}1, ${param.name}2, ..., ${param.name}n`;
+  }
+  return formatted;
+};
 
 const signatures = params 
   ? [`${name}(${params.map(formatParam).join(", ")})`]

src/content/reference/config.ts

@@ -28,6 +28,7 @@ const paramSchema = z.object({
   description: z.string().optional(),
   type: z.string().optional(),
   optional: z.coerce.boolean().optional(),
+  rest: z.coerce.boolean().optional(),
 });
 
 const returnSchema = z.object({

src/layouts/ReferenceItemLayout.astro

@@ -181,7 +181,10 @@ const descriptionParts = description.split(
               {entry.data.params &&
                 entry.data.params.map((param: ReferenceParam) => (
                   <div class="grid grid-cols-6 gap-gutter-md text-body">
-                    <span class="col-span-1 text-body whitespace-normal break-words overflow-wrap-break-word">{param.name}</span>
+                    <span class="col-span-1 text-body whitespace-normal break-words overflow-wrap-break-word">
+
+                      {param.rest ? `${param.name}1, ..., ${param.name}n` : param.name}
+                    </span>
                     <div
                           class="col-span-5 [&_p]:m-0 [&_p]:inline [&_a]:underline"
                     >
@@ -197,7 +200,9 @@ const descriptionParts = description.split(
                     seenParams[param.name] = true;
                     return (
                       <div class="grid grid-cols-6 gap-gutter-md text-body">
-                        <span class="col-span-1">{param.name}</span>
+                        <span class="col-span-1">
+                          {param.rest ? `${param.name}1, ..., ${param.name}n` : param.name}
+                        </span>
                         <div
                           class="col-span-5 [&_p]:m-0 [&_p]:inline [&_a]:underline"
                         >

types/parsers.interface.ts

@@ -40,6 +40,7 @@ export interface ReferenceParam {
   description: string; // A description of the parameter.
   type: string; // The data type of the parameter.
   optional?: boolean; // Indicates if the parameter is optional.
+  rest?: boolean; // Whether or not this is a variadic parameter at the end of the arg list
 }
 
 export type ReferenceOverload = {