\documentclass[10pt,a4paper]{article} % Packages \usepackage{fancyhdr} % For header and footer \usepackage{multicol} % Allows multicols in tables \usepackage{tabularx} % Intelligent column widths \usepackage{tabulary} % Used in header and footer \usepackage{hhline} % Border under tables \usepackage{graphicx} % For images \usepackage{xcolor} % For hex colours %\usepackage[utf8x]{inputenc} % For unicode character support \usepackage[T1]{fontenc} % Without this we get weird character replacements \usepackage{colortbl} % For coloured tables \usepackage{setspace} % For line height \usepackage{lastpage} % Needed for total page number \usepackage{seqsplit} % Splits long words. %\usepackage{opensans} % Can't make this work so far. Shame. Would be lovely. \usepackage[normalem]{ulem} % For underlining links % Most of the following are not required for the majority % of cheat sheets but are needed for some symbol support. \usepackage{amsmath} % Symbols \usepackage{MnSymbol} % Symbols \usepackage{wasysym} % Symbols %\usepackage[english,german,french,spanish,italian]{babel} % Languages % Document Info \author{Eli Sherer (elisherer)} \pdfinfo{ /Title (jest-cheat-sheet.pdf) /Creator (Cheatography) /Author (Eli Sherer (elisherer)) /Subject (Jest Cheat Sheet) } % Lengths and widths \addtolength{\textwidth}{6cm} \addtolength{\textheight}{-1cm} \addtolength{\hoffset}{-3cm} \addtolength{\voffset}{-2cm} \setlength{\tabcolsep}{0.2cm} % Space between columns \setlength{\headsep}{-12pt} % Reduce space between header and content \setlength{\headheight}{85pt} % If less, LaTeX automatically increases it \renewcommand{\footrulewidth}{0pt} % Remove footer line \renewcommand{\headrulewidth}{0pt} % Remove header line \renewcommand{\seqinsert}{\ifmmode\allowbreak\else\-\fi} % Hyphens in seqsplit % This two commands together give roughly % the right line height in the tables \renewcommand{\arraystretch}{1.3} \onehalfspacing % Commands \newcommand{\SetRowColor}[1]{\noalign{\gdef\RowColorName{#1}}\rowcolor{\RowColorName}} % Shortcut for row colour \newcommand{\mymulticolumn}[3]{\multicolumn{#1}{>{\columncolor{\RowColorName}}#2}{#3}} % For coloured multi-cols \newcolumntype{x}[1]{>{\raggedright}p{#1}} % New column types for ragged-right paragraph columns \newcommand{\tn}{\tabularnewline} % Required as custom column type in use % Font and Colours \definecolor{HeadBackground}{HTML}{333333} \definecolor{FootBackground}{HTML}{666666} \definecolor{TextColor}{HTML}{333333} \definecolor{DarkBackground}{HTML}{CA461A} \definecolor{LightBackground}{HTML}{FBF3F0} \renewcommand{\familydefault}{\sfdefault} \color{TextColor} % Header and Footer \pagestyle{fancy} \fancyhead{} % Set header to blank \fancyfoot{} % Set footer to blank \fancyhead[L]{ \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{C} \SetRowColor{DarkBackground} \vspace{-7pt} {\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\noindent \hspace*{-6pt}\includegraphics[width=5.8cm]{/web/www.cheatography.com/public/images/cheatography_logo.pdf}} } \end{tabulary} \columnbreak \begin{tabulary}{11cm}{L} \vspace{-2pt}\large{\bf{\textcolor{DarkBackground}{\textrm{Jest Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{Eli Sherer (elisherer)} via \textcolor{DarkBackground}{\uline{cheatography.com/34195/cs/10692/}}} \end{tabulary} \end{multicols}} \fancyfoot[L]{ \footnotesize \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{LL} \SetRowColor{FootBackground} \mymulticolumn{2}{p{5.377cm}}{\bf\textcolor{white}{Cheatographer}} \\ \vspace{-2pt}Eli Sherer (elisherer) \\ \uline{cheatography.com/elisherer} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Not Yet Published.\\ Updated 30th January, 2017.\\ Page {\thepage} of \pageref{LastPage}. \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Sponsor}} \\ \SetRowColor{white} \vspace{-5pt} %\includegraphics[width=48px,height=48px]{dave.jpeg} Measure your website readability!\\ www.readability-score.com \end{tabulary} \end{multicols}} \begin{document} \raggedright \raggedcolumns % Set font size to small. Switch to any value % from this page to resize cheat sheet text: % www.emerson.emory.edu/services/latex/latex_169.html \footnotesize % Small font. \begin{multicols*}{2} \begin{tabularx}{8.4cm}{x{3.76 cm} x{4.24 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Global Environment}} \tn % Row 0 \SetRowColor{LightBackground} `afterEach(fn)` & Called once after each test \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} `beforeEach(fn)` & Called once before each test \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} `afterAll(fn)` & Called only once after all the tests in describe finish \tn % Row Count 7 (+ 3) % Row 3 \SetRowColor{white} `beforeAll(fn)` & Called only once before all the tests in describe \tn % Row Count 10 (+ 3) % Row 4 \SetRowColor{LightBackground} `describe(name, fn)` & Test suite describer \tn % Row Count 12 (+ 2) % Row 5 \SetRowColor{white} `expect(value)` & Starts an expectation chain \tn % Row Count 14 (+ 2) % Row 6 \SetRowColor{LightBackground} \seqsplit{`expect.extend(matchers)`} & Adds more matchers to expect \tn % Row Count 16 (+ 2) % Row 7 \SetRowColor{white} `expect.\textless{}asymmetric-match\textgreater{}()` & Used as value to match to \tn % Row Count 18 (+ 2) % Row 8 \SetRowColor{LightBackground} `it(name, fn)` & Test describer (another alias for it is `test`) \tn % Row Count 21 (+ 3) % Row 9 \SetRowColor{white} `it.only(name, fn)` & Skip all tests after this one \tn % Row Count 23 (+ 2) % Row 10 \SetRowColor{LightBackground} `it.skip(name, fn)` & Skip this test \tn % Row Count 25 (+ 2) % Row 11 \SetRowColor{white} `fit(name, fn)` & Runs only this test \tn % Row Count 26 (+ 1) % Row 12 \SetRowColor{LightBackground} `jest` & The `jest` object \tn % Row Count 27 (+ 1) % Row 13 \SetRowColor{white} \seqsplit{`require.requireActual(moduleName)`} & Returns the actual module instead of a mock \tn % Row Count 30 (+ 3) \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{8.4cm}{x{3.76 cm} x{4.24 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Global Environment (cont)}} \tn % Row 14 \SetRowColor{LightBackground} \seqsplit{`require.requireMock(moduleName)`} & Returns a mock module instead of the actual module \tn % Row Count 3 (+ 3) % Row 15 \SetRowColor{white} \seqsplit{`xdescribe/xit/xtest`} & Makes the test pending \tn % Row Count 5 (+ 2) % Row 16 \SetRowColor{LightBackground} `fdescribe/fit` & Makes the test/suite the only one running \tn % Row Count 7 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.6 cm} x{4.4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Writing assertions with `expect`}} \tn % Row 0 \SetRowColor{LightBackground} `.not` & Expects the opposite of the rest of the expectation. \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} `.toBe(value)` & Strict equality (`===`) \tn % Row Count 5 (+ 2) % Row 2 \SetRowColor{LightBackground} `.toEqual(value)` & Recursively checks the equality of all fields \tn % Row Count 8 (+ 3) % Row 3 \SetRowColor{white} \mymulticolumn{2}{x{8.4cm}}{`.toMatch(regexp)`} \tn % Row Count 9 (+ 1) % Row 4 \SetRowColor{LightBackground} \seqsplit{`.toMatchObject(object)`} & Matches a subset of the properties of an object \tn % Row Count 12 (+ 3) % Row 5 \SetRowColor{white} \seqsplit{`.toMatchSnapshot()`} & Matches the most recent snapshot (or creates one) \tn % Row Count 15 (+ 3) % Row 6 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{`.toBeDefined()`} \tn % Row Count 16 (+ 1) % Row 7 \SetRowColor{white} \mymulticolumn{2}{x{8.4cm}}{`.toBeUndefined()`} \tn % Row Count 17 (+ 1) % Row 8 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{`.toBeNull()`} \tn % Row Count 18 (+ 1) % Row 9 \SetRowColor{white} \mymulticolumn{2}{x{8.4cm}}{`.toBeTruthy()`} \tn % Row Count 19 (+ 1) % Row 10 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{`.toBeFalsy()`} \tn % Row Count 20 (+ 1) % Row 11 \SetRowColor{white} \mymulticolumn{2}{x{8.4cm}}{\seqsplit{`.toBeGreaterThan(number)`}} \tn % Row Count 21 (+ 1) % Row 12 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{\seqsplit{`.toBeGreaterThanOrEqual(number)`}} \tn % Row Count 22 (+ 1) % Row 13 \SetRowColor{white} \mymulticolumn{2}{x{8.4cm}}{`.toBeLessThan(number)`} \tn % Row Count 23 (+ 1) % Row 14 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{\seqsplit{`.toBeLessThanOrEqual(number)`}} \tn % Row Count 24 (+ 1) % Row 15 \SetRowColor{white} \mymulticolumn{2}{x{8.4cm}}{`.toBeCloseTo(number, numDigits)`} \tn % Row Count 25 (+ 1) % Row 16 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{`.toBeNaN()`} \tn % Row Count 26 (+ 1) % Row 17 \SetRowColor{white} \mymulticolumn{2}{x{8.4cm}}{`.toBeInstanceOf(Class)`} \tn % Row Count 27 (+ 1) % Row 18 \SetRowColor{LightBackground} \seqsplit{`.toContain(item)`} & Strict equality (`===`) \tn % Row Count 29 (+ 2) % Row 19 \SetRowColor{white} \seqsplit{`.toContainEqual(item)`} & Recursively checks the equality of all fields \tn % Row Count 32 (+ 3) \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{8.4cm}{x{3.6 cm} x{4.4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Writing assertions with `expect` (cont)}} \tn % Row 20 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{`.toHaveLength(number)`} \tn % Row Count 1 (+ 1) % Row 21 \SetRowColor{white} \mymulticolumn{2}{x{8.4cm}}{`.toThrow()`} \tn % Row Count 2 (+ 1) % Row 22 \SetRowColor{LightBackground} \seqsplit{`.toThrowError(error)`} & `error` can be a string, RegExp or Class \tn % Row Count 4 (+ 2) % Row 23 \SetRowColor{white} \seqsplit{`.toThrowErrorMatchingSnapshot()`} & Will expect an error while matching (the snapshot will be the error's message) \tn % Row Count 8 (+ 4) % Row 24 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{`.toHaveBeenCalled()`} \tn % Row Count 9 (+ 1) % Row 25 \SetRowColor{white} \mymulticolumn{2}{x{8.4cm}}{\seqsplit{`.toHaveBeenCalledTimes(number)`}} \tn % Row Count 10 (+ 1) % Row 26 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{\seqsplit{`.toHaveBeenCalledWith(arg1}, arg2, ...)`} \tn % Row Count 11 (+ 1) % Row 27 \SetRowColor{white} \mymulticolumn{2}{x{8.4cm}}{\seqsplit{`.toHaveBeenLastCalledWith(arg1}, arg2, ...)`} \tn % Row Count 12 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.76 cm} x{4.24 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Mock functions}} \tn % Row 0 \SetRowColor{LightBackground} `jest.fn()` & Creates a mock function \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} \seqsplit{`mockFn.mock.calls`} & An array that represents all calls that have been made into this mock function \tn % Row Count 6 (+ 4) % Row 2 \SetRowColor{LightBackground} \seqsplit{`mockFn.mock.instances`} & An array that contains all the object instances \tn % Row Count 9 (+ 3) % Row 3 \SetRowColor{white} \seqsplit{`mockFn.mockClear()`} & Resets all information stored in the above arrays. \tn % Row Count 12 (+ 3) % Row 4 \SetRowColor{LightBackground} \seqsplit{`mockFn.mockReset()`} & Resets all information stored in the mock \tn % Row Count 14 (+ 2) % Row 5 \SetRowColor{white} \seqsplit{`mockFn.mockImplementation(fn)`} & Sets a function that should be used as the implementation of the mock \tn % Row Count 18 (+ 4) % Row 6 \SetRowColor{LightBackground} \seqsplit{`mockFn.mockImplementationOnce(fn)`} & Sets a function that should be used as the implementation of the mock for one call \tn % Row Count 22 (+ 4) % Row 7 \SetRowColor{white} \seqsplit{`mockFn.mockReturnThis()`} & Suger for using `jest.fn(()=\textgreater{}this)` \tn % Row Count 24 (+ 2) % Row 8 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{\seqsplit{`mockFn.mockReturnValueOnce(value)`}} \tn % Row Count 25 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{The jest object}} \tn % Row 0 \SetRowColor{LightBackground} \seqsplit{`jest.resetAllMocks()`} & Resets the state of all mocks \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} \seqsplit{`jest.clearAllTimers()`} & Removes any pending timers from the timer system \tn % Row Count 5 (+ 3) % Row 2 \SetRowColor{LightBackground} \seqsplit{`jest.disableAutomock()`} & Disables automatic mocking in the module loader \tn % Row Count 8 (+ 3) % Row 3 \SetRowColor{white} \seqsplit{`jest.enableAutomock()`} & Enables automatic mocking in the module loader \tn % Row Count 11 (+ 3) % Row 4 \SetRowColor{LightBackground} \seqsplit{`jest.fn(?implementation)`} & Returns a new, unused mock function \tn % Row Count 13 (+ 2) % Row 5 \SetRowColor{white} \seqsplit{`jest.isMockFunction(fn)`} & Determines if the given function is a mocked function \tn % Row Count 16 (+ 3) % Row 6 \SetRowColor{LightBackground} \seqsplit{`jest.genMockFromModule(moduleName)`} & Generate a mocked version of the module for you \tn % Row Count 19 (+ 3) % Row 7 \SetRowColor{white} \seqsplit{`jest.mock(moduleName}, ?factory, ?options)` & Mocks a module with an auto-mocked version \tn % Row Count 22 (+ 3) % Row 8 \SetRowColor{LightBackground} \seqsplit{`jest.resetModules()`} & Resets the module registry - the cache of all required modules \tn % Row Count 26 (+ 4) % Row 9 \SetRowColor{white} \seqsplit{`jest.runAllTicks()`} & Exhausts the {\bf{micro}}-task queue \tn % Row Count 28 (+ 2) % Row 10 \SetRowColor{LightBackground} \seqsplit{`jest.runAllTimers()`} & Exhausts the {\bf{macro}}-task queue \tn % Row Count 30 (+ 2) \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{The jest object (cont)}} \tn % Row 11 \SetRowColor{LightBackground} \seqsplit{`jest.runAllImmediates()`} & Exhausts all tasks queued by `setImmediate()` \tn % Row Count 3 (+ 3) % Row 12 \SetRowColor{white} \seqsplit{`jest.runTimersToTime(msToRun)`} & Executes only the macro task queue \tn % Row Count 5 (+ 2) % Row 13 \SetRowColor{LightBackground} \seqsplit{`jest.runOnlyPendingTimers()`} & Executes only the macro-tasks that are currently pending \tn % Row Count 8 (+ 3) % Row 14 \SetRowColor{white} \seqsplit{`jest.setMock(moduleName}, moduleExports)` & Explicitly supplies the mock object that the module system should return for the specified module \tn % Row Count 13 (+ 5) % Row 15 \SetRowColor{LightBackground} \seqsplit{`jest.unmock(moduleName)`} & Indicates that the module system should never return a mocked version of the specified module \tn % Row Count 18 (+ 5) % Row 16 \SetRowColor{white} \seqsplit{`jest.useFakeTimers()`} & Instructs Jest to use fake versions of the standard timer functions \tn % Row Count 22 (+ 4) % Row 17 \SetRowColor{LightBackground} \seqsplit{`jest.useRealTimers()`} & Instructs Jest to use the real versions of the standard timer functions \tn % Row Count 26 (+ 4) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}