The type of the argument for the plan method.
The top-level TestDescriptor instance from which the descriptors of all tests in the suite will "inherit".
For example if the top-level descriptor contains certain value for the defaultTimeout config, then all tests will use that value, unless they explicitly override it.
The human readable title for the whole test suite. Will be included in the output, when starting the test suite.
This method excludes all *.t.m?js test files in the dir directory from the project plan, recursively.
The dir path is resolved relative to the project file.
See also excludeFile, excludeGlob
This method excludes a specific file from the project plan. The file path is resolved relative to the project file.
See also excludeDir, excludeGlob
This method excludes all files, matching the globPattern from the project plan.
The glob matching happens in the project file directory.
See also excludeFile, excludeDir
An alias for planDir
An alias for planFile
An alias for planGlob
This method applies its 1st argument (if any) to the current instance using Object.assign().
Supposed to be overridden in the subclasses to customize the instance creation process.
Project plan is a set of tests to be launched. It is organized as "tree" data structure. The "parent" nodes of this tree usually corresponds to file system directories, and "leaf" nodes - to test files.
This method adds a test descriptor to the project's plan. The descriptor is represented with the value of ProjectPlanItemDescriptor type.
See also TestDescriptor.url for details on specifying the test file url.
For example:
project.plan(
{
// relative to project file
url : 'some_directory',
items : [
// relative to `some_directory`
{ url : 'test_1.t.js' }
// or just:
'test_2.t.js',
]
}
)
This method adds all *.t.m?js test files in the dir directory into the project plan, recursively.
The dir path is resolved relative to the project file.
This method adds a specific test file into the project plan. The file path is resolved relative to the project file. The intermediate entries for the directories, containing the file, will be created as well.
This method adds all files, matching the globPattern into the project plan.
The glob matching happens in the project file directory.
This is a type-safe static constructor method, accepting a single argument. If that argument is already an instance of this class - it is returned right away, otherwise the new constructor is used for instantiation.
This is a type-safe static constructor method, accepting a single argument, with the object, corresponding to the class properties. It will generate a compilation error, if unknown property is provided.
For example:
class MyClass extends Base {
prop : string
}
const instance : MyClass = MyClass.new({ prop : 'prop', wrong : 11 })
will produce:
TS2345: Argument of type '{ prop: string; wrong: number; }' is not assignable to parameter of type 'Partial<MyClass>'.
Object literal may only specify known properties, and 'wrong' does not exist in type 'Partial<MyClass>'
The only thing this constructor does is create an instance and call the initialize method on it, forwarding the first argument. The customization of instance is supposed to be performed in that method.
Generated using TypeDoc
Siesta project for Node.js code.