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

Renamed index.ts to getIndex.ts #557

Merged
merged 3 commits into from
Aug 20, 2020

Conversation

kaffarell
Copy link
Collaborator

FIxes #556

The filename index gets set as main entrypoint by npm
@kaffarell kaffarell self-assigned this Aug 18, 2020
@coveralls
Copy link

coveralls commented Aug 18, 2020

Coverage Status

Coverage remained the same at 76.775% when pulling 12906e7 on kaffarell:master into e344f81 on lukasoppermann:master.

Copy link
Owner

@lukasoppermann lukasoppermann left a comment

Choose a reason for hiding this comment

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

Hey @kaffarell this is great and very quick. To make it even easier to read please also rename the imports from index to get index as well so that the function that is used is always getIndex. Thanks 👍

@kaffarell
Copy link
Collaborator Author

Changed it, by the way what is the underscore at the beginning of the imported function meaning?

@lukasoppermann
Copy link
Owner

Hey @kaffarell thank you. 👍
The underscore is just a naming convention to denote functions or methods that are internal and should not be used as they are not part of the public api and thus may change.
However, here it is a remanence of much earlier versions. Could you please update it here to NOT include it (I know it was there already, but it was good of you to spot it and we should clean it up), thanks.

Afterwards I will be able to merge it. 😄

@kaffarell
Copy link
Collaborator Author

@lukasoppermann This should be complete

@lukasoppermann
Copy link
Owner

Awesome, @kaffarell I was actually only referring to the _index. method, but that is great. :D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename index.ts to to getIndex.ts
3 participants