Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add types for the engines export #158

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add types for the engines export #158

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f8c190
Add types for the engines export
segevfiner Apr 24, 2023
eba35cb
Fix js -> javascript
segevfiner Apr 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions gray-matter.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ declare function matter<
>(input: I | { content: I }, options?: O): matter.GrayMatterFile<I>

declare namespace matter {
type Engine =
| ((input: string) => object)
| { parse: (input: string) => object; stringify?: (data: object) => string }

type Input = string | Buffer
interface GrayMatterOption<
I extends Input,
Expand All @@ -28,11 +32,7 @@ declare namespace matter {
eval?: boolean
excerpt?: boolean | ((input: I, options: O) => string)
excerpt_separator?: string
engines?: {
[index: string]:
| ((input: string) => object)
| { parse: (input: string) => object; stringify?: (data: object) => string }
}
engines?: { [index: string]: Engine }
language?: string
delimiters?: string | [string, string]
}
Expand All @@ -45,6 +45,12 @@ declare namespace matter {
matter: string
stringify(lang: string): string
}

export const engines: {
json: Engine,
yaml: Engine,
javascript: Engine
};

/**
* Stringify an object to YAML or the specified language, and
Expand Down