Skip to content

We could be more forthcoming around internal limits #13

@francisfuzz

Description

@francisfuzz

str-gen/index.js

Lines 14 to 15 in e411321

const MAX_STRING_LENGTH = 10000
const MAX_ARRAY_LENGTH = 10000

Nowhere in the documentation (but, we do say so in the tests), what will happen if either length exceeds the internal limit. This is a great documentation opportunity in the README, but it may also be worth being explicit on throwing an error in either case rather than just returning an empty string which may not be the most user-friendly output to receive, unless the client is comfortable reading through the source.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions