smartfm/ts/index.ts

33 lines
668 B
TypeScript
Raw Normal View History

2019-09-04 12:13:42 +00:00
import grayMatter from 'gray-matter';
2016-11-13 22:11:49 +00:00
export type TFrontMatter = 'yaml' | 'json';
2016-11-13 22:11:49 +00:00
export interface ISmartfmContructorOptions {
fmType: TFrontMatter;
2016-11-13 22:11:49 +00:00
}
/**
* class smartfm handles frontmatter
*/
export class Smartfm {
fmType: TFrontMatter;
2017-03-11 21:34:28 +00:00
constructor(optionsArg: ISmartfmContructorOptions) {
this.fmType = optionsArg.fmType;
2017-03-11 21:34:28 +00:00
}
/**
* add frontmatter to a string
*/
stringify(bodyString: string, frontmatterData: any) {
return grayMatter.stringify(bodyString, frontmatterData);
2017-03-11 21:34:28 +00:00
}
/**
* parse a string that has frontmatter attached, YAML notation
*/
parse(stringToParse: string) {
return grayMatter(stringToParse);
2017-03-11 21:34:28 +00:00
}
2016-11-13 22:11:49 +00:00
}