{"kind":"Package","title":"simple-suite-test Package","summary":"Test package","members":{"Class":{"TestClass":"/simple-suite-test/testclass"},"Variable":{"testConst":"/simple-suite-test#testconst-Variable"},"Interface":{"TestEmptyInterface":"/simple-suite-test/testemptyinterface","TestInterface":"/simple-suite-test/testinterface","TestInterfaceExtendingOtherInterfaces":"/simple-suite-test/testinterfaceextendingotherinterfaces","TestInterfaceWithTypeParameter":"/simple-suite-test/testinterfacewithtypeparameter"},"Enum":{"TestEnum":"/simple-suite-test#testenum-Enum"},"Function":{"testFunction":"/simple-suite-test#testfunction-Function","testFunctionReturningInlineType":"/simple-suite-test#testfunctionreturninginlinetype-Function","testFunctionReturningIntersectionType":"/simple-suite-test#testfunctionreturningintersectiontype-Function","testFunctionReturningUnionType":"/simple-suite-test#testfunctionreturninguniontype-Function"},"TypeAlias":{"TestMappedType":"/simple-suite-test#testmappedtype-TypeAlias","TypeAlias":"/simple-suite-test#typealias-TypeAlias"},"Namespace":{"TestNamespace":"/simple-suite-test/testnamespace"}},"package":"simple-suite-test","unscopedPackageName":"simple-suite-test"}

[//]: # (Do not edit this file. It is automatically generated by API Documenter.)

[Packages](/) > [simple-suite-test](/simple-suite-test)

Test package

## Remarks

This remarks block includes a bulleted list!

- Bullet 1

- Bullet 2

And an ordered list for good measure!

1. List item 1

2. List item 2

3. List item 3

Also, here is a link test, including a bad link, because we should have some reasonable support if this happens:

- Good link (no alias): [TestClass](/simple-suite-test/testclass)

- Good link (with alias): [function alias text](/simple-suite-test#testfunction-Function)

- Bad link (no alias): *InvalidItem*

- Bad link (with alias): *even though I link to an invalid item, I would still like this text to be rendered*

## Example

A test example

```typescript
const foo = bar;
```

## Classes

<table class="table table-striped table-hover class-list">
<caption>List of classes contained in this package</caption>
  <thead>
    <tr>
     <th scope="col">Class</th>
 <th scope="col">Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a href='/simple-suite-test/testclass'>TestClass</a></td>
      <td>Test class</td>
    </tr>
  </tbody>
</table>

## Enumerations

<table class="table table-striped table-hover enum-list">
<caption>List of enums contained in this package</caption>
  <thead>
    <tr>
     <th scope="col">Enumeration</th>
 <th scope="col">Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a href='/simple-suite-test#testenum-Enum'>TestEnum</a></td>
      <td>Test Enum</td>
    </tr>
  </tbody>
</table>

## Functions

<table class="table table-striped table-hover function-list">
<caption>List of functions contained in this package</caption>
  <thead>
    <tr>
     <th scope="col">Function</th>
 <th scope="col">Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a href='/simple-suite-test#testfunction-Function'>testFunction(testParameter)</a></td>
      <td>Test function</td>
    </tr>
    <tr>
      <td><a href='/simple-suite-test#testfunctionreturninginlinetype-Function'>testFunctionReturningInlineType()</a></td>
      <td>Test function that returns an inline type</td>
    </tr>
    <tr>
      <td><a href='/simple-suite-test#testfunctionreturningintersectiontype-Function'>testFunctionReturningIntersectionType()</a></td>
      <td>Test function that returns an inline type</td>
    </tr>
    <tr>
      <td><a href='/simple-suite-test#testfunctionreturninguniontype-Function'>testFunctionReturningUnionType()</a></td>
      <td>Test function that returns an inline type</td>
    </tr>
  </tbody>
</table>

## Interfaces

<table class="table table-striped table-hover interface-list">
<caption>List of interfaces contained in this package</caption>
  <thead>
    <tr>
     <th scope="col">Interface</th>
 <th scope="col">Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a href='/simple-suite-test/testemptyinterface'>TestEmptyInterface</a></td>
      <td>An empty interface</td>
    </tr>
    <tr>
      <td><a href='/simple-suite-test/testinterface'>TestInterface</a></td>
      <td>Test interface</td>
    </tr>
    <tr>
      <td><a href='/simple-suite-test/testinterfaceextendingotherinterfaces'>TestInterfaceExtendingOtherInterfaces</a></td>
      <td>Test interface that extends other interfaces</td>
    </tr>
    <tr>
      <td><a href='/simple-suite-test/testinterfacewithtypeparameter'>TestInterfaceWithTypeParameter</a></td>
      <td>Test interface with generic type parameter</td>
    </tr>
  </tbody>
</table>

## Namespaces

<table class="table table-striped table-hover namespace-list">
<caption>List of namespaces contained in this package</caption>
  <thead>
    <tr>
     <th scope="col">Namespace</th>
 <th scope="col">Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a href='/simple-suite-test/testnamespace'>TestNamespace</a></td>
      <td>Test Namespace</td>
    </tr>
  </tbody>
</table>

## Variables

<table class="table table-striped table-hover variable-list">
<caption>List of variables contained in this package</caption>
  <thead>
    <tr>
     <th scope="col">Variable</th>
 <th scope="col">Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a href='/simple-suite-test#testconst-Variable'>testConst</a></td>
      <td>Test Constant</td>
    </tr>
  </tbody>
</table>

## Type Aliases

<table class="table table-striped table-hover alias-list">
<caption>List of type aliases contained in this package</caption>
  <thead>
    <tr>
     <th scope="col">Type Alias</th>
 <th scope="col">Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a href='/simple-suite-test#testmappedtype-TypeAlias'>TestMappedType</a></td>
      <td>Test Mapped Type, using <a href='/simple-suite-test#testenum-Enum'>TestEnum</a></td>
    </tr>
    <tr>
      <td><a href='/simple-suite-test#typealias-TypeAlias'>TypeAlias</a></td>
      <td>Test Type-Alias</td>
    </tr>
  </tbody>
</table>

<hr><div id=package-details>

## Enumeration Details {#enumerations-details}

### TestEnum enum {#testenum-Enum}

Test Enum

<b>Signature:</b>

```typescript
export declare enum TestEnum 
```

### Enumeration Members

<table class="table table-striped table-hover enum-list">
<caption>List of members in use in this enum</caption>
  <thead>
    <tr>
     <th scope="col">Member</th>
 <th scope="col">Value</th>
 <th scope="col">Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>TestEnumValue1</td>
      <td><code>&quot;test-enum-value-1&quot;</code></td>
      <td>Test enum value 1 (string)</td>
    </tr>
    <tr>
      <td>TestEnumValue2</td>
      <td><code>3</code></td>
      <td>Test enum value 2 (number)</td>
    </tr>
    <tr>
      <td>TestEnumValue3</td>
      <td><code>4</code></td>
      <td>Test enum value 3 (default)</td>
    </tr>
  </tbody>
</table>

#### Remarks {#testenum-Enum-remarks}

Here are some remarks about the enum

#### Example 1 {#testenum-Enum-example-1}

Some example

```typescript
const foo = TestEnum.TestEnumValue1
```

#### Example 2 {#testenum-Enum-example-2}

Another example

```ts
const bar = TestEnum.TestEnumValue2
```


## Function Details {#functions-details}

### testFunction {#testfunction-Function}

Test function

<b>Signature:</b>

```typescript
export declare function testFunction<TTypeParameter>(testParameter: TTypeParameter): TTypeParameter;
```

#### Parameters {#testfunction-Function-parameters}


<table class="table table-striped table-hover param-list">
<caption>List of parameters</caption>
  <thead>
    <tr>
     <th scope="col">Parameter</th>
 <th scope="col">Type</th>
 <th scope="col">Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>testParameter</td>
      <td>TTypeParameter</td>
      <td>A test parameter</td>
    </tr>
  </tbody>
</table>

#### Returns {#testfunction-Function-returns}


The provided parameter

<b>Return type(s):</b> TTypeParameter

#### Exceptions: {#testfunction-Function-exceptions}


- An Error

#### Remarks {#testfunction-Function-remarks}

This is a test [link](/simple-suite-test/testinterface) to another API member

### testFunctionReturningInlineType {#testfunctionreturninginlinetype-Function}

Test function that returns an inline type

<b>Signature:</b>

```typescript
export declare function testFunctionReturningInlineType(): {
    foo: number;
    bar: TestEnum;
};
```

#### Returns {#testfunctionreturninginlinetype-Function-returns}


An inline type

<b>Return type(s):</b> { foo: number; bar: [TestEnum](/simple-suite-test#testenum-Enum)<!-- -->; }

### testFunctionReturningIntersectionType {#testfunctionreturningintersectiontype-Function}

Test function that returns an inline type

<b>Signature:</b>

```typescript
export declare function testFunctionReturningIntersectionType(): TestEmptyInterface & TestInterfaceWithTypeParameter<number>;
```

#### Returns {#testfunctionreturningintersectiontype-Function-returns}


An intersection type

<b>Return type(s):</b> [TestEmptyInterface](/simple-suite-test/testemptyinterface) &amp; [TestInterfaceWithTypeParameter](/simple-suite-test/testinterfacewithtypeparameter)<!-- -->&lt;number&gt;

### testFunctionReturningUnionType {#testfunctionreturninguniontype-Function}

Test function that returns an inline type

<b>Signature:</b>

```typescript
export declare function testFunctionReturningUnionType(): string | TestInterface;
```

#### Returns {#testfunctionreturninguniontype-Function-returns}


A union type

<b>Return type(s):</b> string \| [TestInterface](/simple-suite-test/testinterface)


## Variable Details {#variables-details}

### testConst {#testconst-Variable}

Test Constant

<b>Signature:</b>

```typescript
testConst = 42
```

#### Remarks {#testconst-Variable-remarks}

Here are some remarks about the variable


## Type Alias Details {#type-aliases-details}

### TestMappedType {#testmappedtype-TypeAlias}

Test Mapped Type, using [TestEnum](/simple-suite-test#testenum-Enum)

<b>Signature:</b>

```typescript
export declare type TestMappedType = {
    [K in TestEnum]: boolean;
};
```

#### Remarks {#testmappedtype-TypeAlias-remarks}

Here are some remarks about the mapped type

### TypeAlias {#typealias-TypeAlias}

Test Type-Alias

<b>Signature:</b>

```typescript
export declare type TypeAlias = string;
```

#### Remarks {#typealias-TypeAlias-remarks}

Here are some remarks about the type alias


</div>