# PackageDirectory

* jsx

  ```tsx
  import { PackageDirectory } from "@alloy-js/typescript";


  <PackageDirectory
    author="string"
    dependencies={Record<string, string>}
    description="string"
    devDependencies={Record<string, string>}
    exports={PackageExports | ExportPath}
    homepage="string"
    keywords={string[]}
    license="string"
    name="string"
    packages={[
            ExternalPackage,
            {
                version?: string;
                kind?: "dependencies" | "peerDependencies" | "devDependencies";
            }
        ][]}
    path="string"
    peerDependencies={Record<string, string>}
    repository={string | {
            type: string;
            url: string;
        }}
    scripts={Record<string, string>}
    tsConfig={{
            outDir?: string;
        }}
    type={"module" | "commonjs"}
    version="string"
  >
    {children}
  </PackageDirectory>
  ```

* stc

  ```ts
  import { PackageDirectory } from "@alloy-js/typescript/stc";


  PackageDirectory({
    author: string,
    dependencies: Record<string, string>,
    description: string,
    devDependencies: Record<string, string>,
    exports: PackageExports | ExportPath,
    homepage: string,
    keywords: string[],
    license: string,
    name: string,
    packages: [
            ExternalPackage,
            {
                version?: string;
                kind?: "dependencies" | "peerDependencies" | "devDependencies";
            }
        ][],
    path: string,
    peerDependencies: Record<string, string>,
    repository: string | {
            type: string;
            url: string;
        },
    scripts: Record<string, string>,
    tsConfig: {
            outDir?: string;
        },
    type: "module" | "commonjs",
    version: string,
  }).children(children)
  ```

## Props

|                  |                                                                                                                                                           |                                                                                                                                                                                                                                                                                                          |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| author           | optional string                                                                                                                                           | The author of the package                                                                                                                                                                                                                                                                                |
| children         | optional[Children](../../../core/types/children/)                                                                                                         |                                                                                                                                                                                                                                                                                                          |
| dependencies     | optional Record\<string, string>                                                                                                                          | The hard-coded dependencies of the package. References to external packages will add to the dependency list automatically. Only list dependencies here that are not referenced via refkey.                                                                                                               |
| description      | optional string                                                                                                                                           | The description of the package                                                                                                                                                                                                                                                                           |
| devDependencies  | optional Record\<string, string>                                                                                                                          | The dev dependencies of the package.                                                                                                                                                                                                                                                                     |
| exports          | optional[PackageExports](../../types/packageexports/) \| [ExportPath](../../types/exportpath/)                                                            | The hard-coded exports of the package.                                                                                                                                                                                                                                                                   |
| homepage         | optional string                                                                                                                                           | The homepage of the package                                                                                                                                                                                                                                                                              |
| keywords         | optional string\[]                                                                                                                                        | The keywords of the package                                                                                                                                                                                                                                                                              |
| license          | optional string                                                                                                                                           | The license of the package                                                                                                                                                                                                                                                                               |
| name             | string                                                                                                                                                    | The name of the package                                                                                                                                                                                                                                                                                  |
| packages         | optional \[ [ExternalPackage](../../types/externalpackage/), { version?: string; kind?: “dependencies” \| “peerDependencies” \| “devDependencies”; } ]\[] | Optional configuration values for referenced external packages. By default, external packages are added as regular dependencies. However you can specify `peerDependencies` or `devDependencies` to change this behavior. Version can also be specified here to override the configured package version. |
| path             | optional string                                                                                                                                           |                                                                                                                                                                                                                                                                                                          |
| peerDependencies | optional Record\<string, string>                                                                                                                          | The peer dependencies of the package.                                                                                                                                                                                                                                                                    |
| repository       | optional string \| { type: string; url: string; }                                                                                                         | The repository of the package                                                                                                                                                                                                                                                                            |
| scripts          | optional Record\<string, string>                                                                                                                          | The scripts entries of the package.                                                                                                                                                                                                                                                                      |
| tsConfig         | optional { outDir?: string; }                                                                                                                             |                                                                                                                                                                                                                                                                                                          |
| type             | optional “module” \| “commonjs”                                                                                                                           | Whether this is a commonjs or module. Defaults to module.                                                                                                                                                                                                                                                |
| version          | string                                                                                                                                                    | The version of the package                                                                                                                                                                                                                                                                               |