check-ends-with-period/module/index.d.ts

Check the text is ends with period mark.

export type CheckEndsWithPeriodOptions = {
    periodMarks?: string[];
    allowExceptionMark?: boolean;
    allowEmoji?: boolean;
};
/**
 * Check ends with period.
 * @param {string} lineText
 * @param {string[]} [periodMarks]
 * @param {boolean} [allowExceptionMark] often used at end.
 * @param {boolean} [allowEmoji]
 * @returns {{valid: boolean, periodMark: string, index: number}}
 *
 * `index` is index value of last character.
 * If last character is a parts of periodMarks, `index` is the position of periodMark.
 * If last character is not a parts of periodMarks, `index` is the position of the last character.
 * If last character is white space, `index` is the position of starting of white space on the end.
 */
export declare const checkEndsWithPeriod: (lineText: string, { periodMarks, allowExceptionMark, allowEmoji, }?: CheckEndsWithPeriodOptions) => {
    valid: boolean;
    periodMark: string;
    index: number;
};
//# sourceMappingURL=index.d.ts.map