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

update error handling for custom flows guide #1034

Merged
merged 2 commits into from
May 14, 2024

Conversation

alexisintech
Copy link
Member

@alexisintech alexisintech commented May 13, 2024

@alexisintech alexisintech requested a review from a team as a code owner May 13, 2024 19:36
Copy link

Hey, here’s your docs preview: https://clerk.com/docs/pr/1034


An interface that represents an error returned by the Clerk API.

```typescript
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not necessarily opposed to this, but it doesn't seem like we put the interface in a codeblock like this for the other type references.

I think it's smart to add this because the meta property is so complex, but I worry we'll forget that reasoning and in the future feel the need to add codeblocks of entire interfaces in other type docs, which is kind of redundant.

What do you think of adding something like this below the property table?

The meta property consists of the following structure:

 meta?: {
   paramName?: string;
   sessionId?: string;
  emailAddresses?: string[];
   identifiers?: string[];
   zxcvbn?: {
     suggestions: {
       code: string;
       message: string;
     }[];
   };
   permissions?: string[];
 };

@alexisintech alexisintech merged commit 5330e6d into main May 14, 2024
2 checks passed
@alexisintech alexisintech deleted the aa/update-error-handling branch May 14, 2024 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants