Module: libs/vscode-common/testUtil/takeSnapshot
Namespaces
Type aliases
ExcludableSnapshotField
Ƭ ExcludableSnapshotField: keyof TestCaseSnapshot
Defined in
libs/vscode-common/testUtil/takeSnapshot.ts:17
ExtraSnapshotField
Ƭ ExtraSnapshotField: keyof TestCaseSnapshot
Defined in
libs/vscode-common/testUtil/takeSnapshot.ts:16
TestCaseSnapshot
Ƭ TestCaseSnapshot: Object
Type declaration
| Name | Type | Description |
|---|---|---|
clipboard? | string | - |
documentContents | string | - |
marks? | SerializedMarks | - |
metadata? | unknown | Extra information about the snapshot. Must be json serializable |
selections | SelectionPlainObject[] | - |
sourceMark? | TargetPlainObject[] | - |
thatMark? | TargetPlainObject[] | - |
timeOffsetSeconds? | number | - |
visibleRanges? | RangePlainObject[] | - |
Defined in
libs/vscode-common/testUtil/takeSnapshot.ts:19
Functions
takeSnapshot
▸ takeSnapshot(thatMark, sourceMark, excludeFields?, extraFields?, editor, ide, marks?, extraContext?, metadata?, clipboard?): Promise<TestCaseSnapshot>
Parameters
| Name | Type | Default value |
|---|---|---|
thatMark | undefined | ThatMark | undefined |
sourceMark | undefined | ThatMark | undefined |
excludeFields | keyof TestCaseSnapshot[] | [] |
extraFields | keyof TestCaseSnapshot[] | [] |
editor | TextEditor | undefined |
ide | IDE | undefined |
marks? | SerializedMarks | undefined |
extraContext? | ExtraContext | undefined |
metadata? | unknown | undefined |
clipboard? | Clipboard | undefined |
Returns
Promise<TestCaseSnapshot>
Defined in
libs/vscode-common/testUtil/takeSnapshot.ts:41