feat(module): add screener

[z3nful]

Changes

• Adds screener module (supercedes dailyGainers as dailyGainers is a form of this)

Type

• New Module
• Other New Feature
• Validation Fix
• Other Bugfix
• Docs
• Chore/other

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:

• aggressive_small_caps
• conservative_foreign_funds
• day_gainers
• day_losers
• growth_technology_stocks
• high_yield_bond
• most_actives
• most_shorted_stocks
• portfolio_anchors
• small_cap_gainers
• solid_large_growth_funds
• solid_midcap_growth_funds
• top_mutual_funds
• undervalued_growth_stocks
• undervalued_large_caps

[codecov]

Codecov Report

All modified lines are covered by tests ✅

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

Additional details and impacted files

@@            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	Coverage Δ
src/modules/screener.ts	100.00% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[gadicc]

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

So greatly appreciate all these amazing contributions.

[gadicc]

🎉 This PR is included in version 2.8.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[z3nful]

Ty, happy to contribute 😊