Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 1.41 KB

REGISTRY.md

File metadata and controls

38 lines (27 loc) · 1.41 KB

Registry

This is located at src/www/src/registry/. It is source code for all the registry methods.

Folder Structure

└──[type]
    └──[category]
        └──[method]
            ├── index.ts
            ├── index.test.ts
            ├── docs.md
            ├── props.ts
            └── *.example.ts
  • type: The type of the method. kebab-case is used while writing the folder name. Eg.

    • functions: JavaScript utility functions.
    • react-hooks: React hooks. (Expected to be added in future)
    • etc
  • category: The category of the method. Eg. array, object, string, etc. kebab-case is used while writing the folder name.

  • method: The method name. Eg. chunk, mapObj, search, capitalize, etc. camelCase is used while writing the folder name.

Files

  • index.ts: The source code of the method.
  • index.test.ts: The test file for the method.
  • *.example.ts: The example file for the method. At least one example file is required.
  • docs.md: The documentation for the method. It shoul have desc as the short description for method and full details description, you can refer the implementation in one of the registry function. _ props.ts: It is a object that includes the details about the propa for the method.

You can see any of the existing methods for reference. here