From 687f45ec25e613399f031497634c4102935d114d Mon Sep 17 00:00:00 2001 From: Chase Fleming Date: Fri, 18 Nov 2022 10:55:21 -0800 Subject: [PATCH] PKG -- [util-uid] Add JSDoc for uid package (#1496) Co-authored-by: Chase Fleming <1666730+chasefleming@users.noreply.github.com> --- .changeset/swift-birds-fold.md | 5 +++++ packages/util-uid/src/util-uid.js | 6 ++++-- 2 files changed, 9 insertions(+), 2 deletions(-) create mode 100644 .changeset/swift-birds-fold.md diff --git a/.changeset/swift-birds-fold.md b/.changeset/swift-birds-fold.md new file mode 100644 index 000000000..b27f1bd17 --- /dev/null +++ b/.changeset/swift-birds-fold.md @@ -0,0 +1,5 @@ +--- +"@onflow/util-uid": minor +--- + +Add JSDoc for util-uid package. diff --git a/packages/util-uid/src/util-uid.js b/packages/util-uid/src/util-uid.js index 4a817fcc4..878d61dd8 100644 --- a/packages/util-uid/src/util-uid.js +++ b/packages/util-uid/src/util-uid.js @@ -1,5 +1,7 @@ -// Inspired by: https://github.com/lukeed/uid/blob/master/src/index.js , thank you Luke! https://github.com/lukeed - +/** + * Generates a unique identifier + * @returns {string} + */ var HEX = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789" var T = HEX.length