ReactiveX / rxjs-docs

The home for new work on the new RxJS docs (RxJS v 5 and up). New to this space? Say hi here: https://github.com/ReactiveX/rxjs-docs/issues/24. Want to find out what's up? We're chatting here. https://github.com/ReactiveX/rxjs-docs/issues/4
Apache License 2.0
160 stars 62 forks source link

feat(operators): Add signature based on parameters collection #284

Open DiedrikDM opened 6 years ago

DiedrikDM commented 6 years ago

Resolve signature from name, parameters and return type values as per #168. This change includes an update to the OperatorDoc type, because the return type of every operator needed to be included. All existing operators have been updated as well to include the correct return type. Some updates to the css were required to add colors to the signature. Added a new pipe (ArgumentPipe) to create a nice tooltip when hovering over the arguments.

codecov-io commented 6 years ago

Codecov Report

Merging #284 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #284   +/-   ##
=======================================
  Coverage   90.78%   90.78%           
=======================================
  Files         116      116           
  Lines         445      445           
  Branches        9        9           
=======================================
  Hits          404      404           
  Misses         40       40           
  Partials        1        1
Impacted Files Coverage Δ
src/operator-docs/combination/mergeAll.ts 100% <ø> (ø) :arrow_up:
src/operator-docs/transformation/partition.ts 100% <ø> (ø) :arrow_up:
src/operator-docs/transformation/bufferCount.ts 100% <ø> (ø) :arrow_up:
src/operator-docs/combination/concatAll.ts 100% <ø> (ø) :arrow_up:
src/operator-docs/combination/startWith.ts 100% <ø> (ø) :arrow_up:
src/operator-docs/filtering/take.ts 100% <ø> (ø) :arrow_up:
src/operator-docs/filtering/debounce.ts 100% <ø> (ø) :arrow_up:
src/operator-docs/transformation/window.ts 100% <ø> (ø) :arrow_up:
src/operator-docs/transformation/switchMap.ts 100% <ø> (ø) :arrow_up:
src/operator-docs/combination/withLatestFrom.ts 100% <ø> (ø) :arrow_up:
... and 34 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 937bc7d...f729c8b. Read the comment docs.

niklas-wortmann commented 6 years ago

First of all thanks for this much work! I will take a look at this pr and give some feedback.

DiedrikDM commented 6 years ago

@JWO719 I'm also pretty sure that a more UX proficient person (than me) should look at it. I made a couple of choices right now in the implementation, like colors and a tooltip that maybe could/should be done in an other way...

ashwin-sureshkumar commented 6 years ago

@DiedrikDM - please resolve conflicts