gadicc / node-yahoo-finance2

Unofficial API for Yahoo Finance
https://www.npmjs.com/package/yahoo-finance2
MIT License
374 stars 62 forks source link

feat(module): add screener #688

Closed z3nful closed 1 year ago

z3nful commented 1 year ago

Changes

Type

Comments/notes

import yahooFinance from 'yahoo-finance2';
const queryOptions = { scrIds: 'aggressive_small_caps', count: 5, region: 'US', lang: 'en-US' };
const result = await yahooFinance.screener(queryOptions);

Accepts the following predefined screener names:

codecov[bot] commented 1 year ago

Codecov Report

All modified lines are covered by tests :white_check_mark:

Comparison is base (fe6de09) 93.05% compared to head (2a7011e) 93.12%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## devel #688 +/- ## ========================================== + Coverage 93.05% 93.12% +0.07% ========================================== Files 25 26 +1 Lines 662 669 +7 Branches 225 226 +1 ========================================== + Hits 616 623 +7 Misses 46 46 ``` | [Files](https://app.codecov.io/gh/gadicc/node-yahoo-finance2/pull/688?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Gadi+Cohen) | Coverage Δ | | |---|---|---| | [src/modules/screener.ts](https://app.codecov.io/gh/gadicc/node-yahoo-finance2/pull/688?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Gadi+Cohen#diff-c3JjL21vZHVsZXMvc2NyZWVuZXIudHM=) | `100.00% <100.00%> (ø)` | |

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

gadicc commented 1 year ago

Ooh, amazing! Thanks, @z3nful, for another :100: PR; code style, docs, tests, all perfect!

So greatly appreciate all these amazing contributions.

gadicc commented 1 year ago

:tada: This PR is included in version 2.8.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

z3nful commented 1 year ago

Ty, happy to contribute 😊