@bitfiber/utils 1.0.0 → 1.0.1

package/CODE_OF_CONDUCT.md

@@ -1,127 +1,127 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at bitfiber.web@gmail.com.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at bitfiber.web@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/CONTRIBUTING.md

@@ -1,87 +1,109 @@
-# Contributing Guidelines
-
-Thank you for considering contributing to our "@bitfiber/utils" library!
-We welcome contributions from the community to help improve and expand the functionality of our library.
-By contributing, you can help make our library more useful for developers across different projects and domains.
-
-## Code of Conduct
-
-Before getting started, please review
-our [Code of Conduct](https://github.com/bitfiber/utils/blob/main/CODE_OF_CONDUCT.md) to understand the behavior that is
-expected of all contributors.
-
-## Getting Started
-
-To contribute to our "@bitfiber/utils" library, follow these steps:
-
-1. Fork the [GitHub Repository](https://github.com/bitfiber/utils) to your own GitHub account.
-
-2. Clone the forked repository to your local machine.
-
-3. Create a new branch,
-   see [guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository).  
-   Branch naming conventions:
-
-    - For features: `feature/<your-feature-branch-name>`
-    - For bug fixes: `fix/<your-bugfix-branch-name>`.
-    - For tests: `tests/<your-tests-branch-name>`.
-    - For docs: `docs/<your-docs-branch-name>`.
-    - For refactoring: `refactor/<your-refactoring-branch-name>`
-    - For performance improving: `perf/<your-performance-branch-name>`
-
-4. Switch to the newly created branch.
-
-5. Go into repository folder by running:
-
-    ```bash
-    cd utils
-    ```
-
-6. Install dependencies by running:
-
-   ```bash
-   npm install
-   ```
-
-7. Make your changes, following the guidelines and best practices outlined below.
-
-8. Run tests to ensure that your changes haven't introduced any regressions by running:
-
-   ```bash
-   nx test utils
-   ```
-
-9. Push your changes to your forked repository.
-
-10. Submit a pull request (PR) to the [repository`s main branch](https://github.com/bitfiber/utils/tree/main),
-    explaining the purpose and scope of your changes.
-
-## Guidelines and Best Practices
-
-To ensure that your contributions are accepted and integrated smoothly, please adhere to the following guidelines and
-best practices:
-
-* **Follow the Style Guide**: Maintain consistency with the existing codebase by following our eslint coding style.
-
-* **Write Tests**: Ensure that your changes are covered by tests. Write unit tests for new functionality and update
-  existing tests for changes to ensure full test coverage.
-
-* **Document Changes**: Provide clear and concise documentation for any new functionality or changes made to existing
-  functionality. This includes updating README.md, adding JSDoc comments, and any other relevant documentation.
-
-* **Keep PRs Small and Focused**: Submit separate PRs for each logical change or set of related changes. This makes it
-  easier to review and merge your contributions.
-
-* **Be Responsive**: Be responsive to feedback and comments on your PRs. Address any review comments promptly and make
-  necessary adjustments to your code.
-
-* **Respect Licensing**: Ensure that your contributions adhere to the licensing terms of the project. If you're
-  introducing dependencies with different licenses, make sure they are compatible with our project's license.
-
-## Need Help?
-
-If you need any assistance or have questions about contributing, feel free to reach out to us
-via [our community discussion forum](https://github.com/bitfiber/utils/discussions). We're here to help!
-
-Thank you for your interest in contributing to our "@bitfiber/utils" library.
-We appreciate your support and look forward to your contributions!
+# Contributing Guidelines
+
+Thank you for considering contributing to our "@bitfiber/utils" library!
+We welcome contributions from the community to help improve and expand the functionality of our library.
+By contributing, you can help make our library more useful for developers across different projects and domains.
+
+## Code of Conduct
+
+Before getting started, please review
+our [Code of Conduct](https://github.com/bitfiber/utils/blob/main/CODE_OF_CONDUCT.md) to understand the behavior that is
+expected of all contributors.
+
+## Getting Started
+
+To contribute to our "@bitfiber/utils" library, follow these steps:
+
+1. Fork the [GitHub Repository](https://github.com/bitfiber/utils) to your own GitHub account.
+
+2. Clone the forked repository to your local machine.
+
+3. Create a new branch,
+   see [guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository).  
+   Branch naming conventions:
+
+    - For features: `feature/<your-feature-branch-name>`
+    - For bug fixes: `fix/<your-bugfix-branch-name>`.
+    - For tests: `tests/<your-tests-branch-name>`.
+    - For docs: `docs/<your-docs-branch-name>`.
+    - For refactoring: `refactor/<your-refactoring-branch-name>`
+    - For performance improving: `perf/<your-performance-branch-name>`
+
+4. Switch to the newly created branch.
+
+5. Go into repository folder by running:
+
+    ```bash
+    cd utils
+    ```
+6. Install Node.js using nvm:  
+   `<version>` - take the Node.js version
+   from [nx node versions](https://nx.dev/nx-api/workspace/documents/nx-nodejs-typescript-version-matrix) considering
+   the nx version in package.json
+
+    ```bash
+    nvm install <version>
+    nvm use <version>
+    ```
+
+7. Install nx globally:  
+   `<version>` - version as in package.json
+
+    ```bash
+    npm add --global nx@<version>
+    ```
+
+8. Install dependencies by running:
+
+   ```bash
+   npm install
+   ```
+
+9. Make your changes, following the guidelines and best practices outlined below.
+
+10. Run tests to ensure that your changes haven't introduced any regressions by running:
+
+    ```bash
+    nx test utils
+    ```
+
+11. Ensure your code adheres to the style guidelines by running ESLint:
+
+    ```bash
+    nx lint utils
+    ```
+
+12. Push your changes to your forked repository.
+
+13. Submit a pull request (PR) to the [repository`s main branch](https://github.com/bitfiber/utils/tree/main),
+    explaining the purpose and scope of your changes.
+
+## Guidelines and Best Practices
+
+To ensure that your contributions are accepted and integrated smoothly, please adhere to the following guidelines and
+best practices:
+
+* **Follow the Style Guide**: Maintain consistency with the existing codebase by following our eslint coding style.
+
+* **Write Tests**: Ensure that your changes are covered by tests. Write unit tests for new functionality and update
+  existing tests for changes to ensure full test coverage.
+
+* **Document Changes**: Provide clear and concise documentation for any new functionality or changes made to existing
+  functionality. This includes updating README.md, adding JSDoc comments, and any other relevant documentation.
+
+* **Keep PRs Small and Focused**: Submit separate PRs for each logical change or set of related changes. This makes it
+  easier to review and merge your contributions.
+
+* **Be Responsive**: Be responsive to feedback and comments on your PRs. Address any review comments promptly and make
+  necessary adjustments to your code.
+
+* **Respect Licensing**: Ensure that your contributions adhere to the licensing terms of the project. If you're
+  introducing dependencies with different licenses, make sure they are compatible with our project's license.
+
+## Need Help?
+
+If you need any assistance or have questions about contributing, feel free to reach out to us
+via [our community discussion forum](https://github.com/bitfiber/utils/discussions). We're here to help!
+
+Thank you for your interest in contributing to our "@bitfiber/utils" library.
+We appreciate your support and look forward to your contributions!

package/index.d.ts

@@ -1 +1,7 @@
 export * from './common';
+export * from './num';
+export * from './str';
+export * from './obj';
+export * from './arr';
+export * from './dom';
+export * from './env';

package/index.js

@@ -1,2 +1,8 @@
 export * from './common';
+export * from './num';
+export * from './str';
+export * from './obj';
+export * from './arr';
+export * from './dom';
+export * from './env';
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../package/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../package/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bitfiber/utils",
   "description": "Collection of versatile utility functions for Javascript",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "module",
   "module": "./src/index.js",
   "main": "./index.js",