Skip to content

Commit

Permalink
Add documentation for new class
Browse files Browse the repository at this point in the history
  • Loading branch information
danieljbruce committed Aug 29, 2024
1 parent e0aec6a commit 4bd19b1
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/row-data-utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,12 @@ export interface RowProperties {
reqOpts: TabularApiSurfaceRequest;
}

// A class is required because of the mock
/**
* RowDataUtils is a class containing functionality needed by the Row and
* AuthorizedView classes. Its static methods need to be contained in a class
* so that they can be mocked out using the sinon library as is conventional
* throughout the rest of the client library.
*/
class RowDataUtils {
/**
* Called by `filter` methods for fulfilling table and authorized view requests.
Expand Down

0 comments on commit 4bd19b1

Please sign in to comment.