Snapshot method

[igorkamyshev]

Description

Hello. I create the same operator in Aviasales codebase and after that I found discussion about it #96 in this repo. So I decided to move implementation here.

Checklist for a new method

• Create directory for new method in root in param-case
• Place code to {method-name}/index.js in CommonJS export in camelCase named export
• Add types to {method-name}/index.d.ts
• Add tests to {method-name}/{method-name}.test.ts
• Add fork tests to {method-name}/{method-name}.fork.test.ts
• Add type tests to test-typings/{method-name}.ts
  • Use // @ts-expect-error to mark expected type error
  • import { expectType } from 'tsd' to check expected return type
• Add documentation in {method-name}/reade.md
  • Add header Patronum/MethodName
  • Add section with overloads, if have
  • Add Motivation, Formulae, Arguments and Return sections for each overload
  • Add useful examples in Example section for each overload
• Add section to README.md in root
  • Add method to table of contents - [MethodName](#methodname)
  • Add section ## [MethodName](/method-name 'Documentation')
  • With summary and simple example

[igorkamyshev]

Also, I think types of this method are pretty simple, and I am not sure, should I write tests for it?

[sergeysova]

@igorkamyshev I think it is better to add type tests

[igorkamyshev]

@igorkamyshev I think it is better to add type tests

Done.

Also, I've updated snapshots for tests. I didn't touch code of the functions, so I think it is just test-flapping. Maybe we can replace snapshot-testing by more stable technics?

[igorkamyshev]

I found this PR had been approved. So, do you have plans of release it?

[igorkamyshev]

@sergeysova sorry for interruption. It looks like ready for release. Could you please merge it? Or should I fix something?