Skip to content

Commit

Permalink
docs: remove unnecessary API description
Browse files Browse the repository at this point in the history
  • Loading branch information
Gumball12 committed Mar 9, 2024
1 parent a7fec40 commit 5b7613a
Showing 1 changed file with 0 additions and 28 deletions.
28 changes: 0 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,34 +216,6 @@ type GenerateDtsFileOptions = Partial<{

To create a custom parser, see the [Writing a custom parser](./src/parser/README.md#writing-a-custom-parser) section.

### `createDts`

```ts
function createDts(params: CreateDtsParams): string;

type CreateDtsParams = {
name: string;
object: object;
options?: CreateDtsOptions;
};

type CreateDtsOptions = Partial<{
defaultType: string;
importTypes: Import[];
}>;

type Import = {
name: string;
from: string;
};
```

- `name`: Name of the type.
- `object`: Content for the types.
- `options`
- `defaultType`: Type to use when the sheet type is an empty string, `undefined`, or `null`. Default is `any`.
- `importTypes`: Types to import from inside the file.

## License

[MIT](./LICENSE) @Gumball12

0 comments on commit 5b7613a

Please sign in to comment.