@platform/ts

  • Version 4.1.23
  • Published
  • 50.5 kB
  • 4 dependencies
  • MIT license

Install

npm i @platform/ts
yarn add @platform/ts
pnpm add @platform/ts

Overview

TypesScript build, prepare and publish toolchain.

Index

Type Aliases

type IPackageFieldMap

type IPackageFieldMap = {
[key: string]: string;
};

    type IPackageJson

    type IPackageJson = {
    name?: string;
    description?: string;
    main?: string;
    types?: string;
    dependencies?: IPackageFieldMap;
    devDependencies?: IPackageFieldMap;
    scripts?: IPackageFieldMap;
    files?: string[];
    };

      type ITypescriptConfig

      type ITypescriptConfig = {
      extends?: string;
      compilerOptions?: {
      outDir?: string;
      rootDir?: string;
      };
      };

        Namespaces

        namespace cmds

        module 'lib/cmds/cmds.d.ts' {}

          function build

          build: (args: IArgs) => Promise<IResult & { errorLog?: string }>;

            function buildAs

            buildAs: (formats: BuildFormat[], args?: IBuildArgs) => Promise<IResult>;

              function chmod

              chmod: (args?: { silent?: boolean; permissions?: string }) => Promise<IResult>;

                function lint

                lint: (args?: { dir?: string; silent?: boolean }) => Promise<IResult>;

                  function prepare

                  prepare: (args?: { dir?: string; silent?: boolean }) => Promise<IResult>;

                    function processArgs

                    processArgs: (
                    args: IArgs
                    ) => Promise<
                    | {
                    code: number;
                    error: Error;
                    cwd?: undefined;
                    outDir?: undefined;
                    silent?: undefined;
                    watch?: undefined;
                    as?: undefined;
                    tsconfig?: undefined;
                    }
                    | {
                    code: number;
                    cwd: string;
                    outDir: string;
                    silent: boolean | undefined;
                    watch: boolean | undefined;
                    as: BuildFormat;
                    tsconfig: string | undefined;
                    error?: undefined;
                    }
                    >;

                      function publish

                      publish: (args?: {
                      silent?: boolean;
                      dir?: string;
                      outDir?: string;
                      }) => Promise<IResult>;

                        function test

                        test: (args?: {
                        dir?: string;
                        silent?: boolean;
                        watch?: boolean;
                        suffix?: string;
                        }) => Promise<IResult>;

                          type BuildFormat

                          type BuildFormat = 'COMMON_JS' | 'ES_MODULE';

                            type IBuildArgs

                            type IBuildArgs = {
                            silent?: boolean;
                            watch?: boolean;
                            dir?: string;
                            outDir?: string;
                            tsconfig?: string;
                            };

                              Package Files (9)

                              Dependencies (4)

                              Dev Dependencies (1)

                              Peer Dependencies (0)

                              No peer dependencies.

                              Badge

                              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@platform/ts.

                              • Markdown
                                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@platform/ts)
                              • HTML
                                <a href="https://www.jsdocs.io/package/@platform/ts"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>