packages/kitsu-core/types/splitModel/index.d.ts
/**
* Split model name from the model's resource URL
*
* @name splitModel
* @param {string} url URL path for the model
* @param {Object} [options] Optional configuration for camelCase and pluralisation handling
* @param {Function} [options.resourceCase=s=>s] Convert libraryEntries to library-entries or library_entries (default no conversion). To use parameter, import kebab or snake from kitsu-core
* @param {Function} [options.pluralModel=s=>s] Pluralise models (default no pluralisation). To use parameter, import pluralize (or another pluralisation npm package)
* @returns {[string, string]}} Array containing the model name and the resource URL with pluralisation applied
*
* @example
* splitModel('posts/1/comments')
* // [ 'comments', 'posts/1/comments' ]
*
* @example <caption>With pluralModel option</caption>
* import plural from 'pluralize'
* splitModel('posts/1/comment', { pluralModel: plural })
* // [ 'comment', 'posts/1/comments' ]
*
* @example <caption>With resourceCase option</caption>
* import { kebab, snake } from 'kitsu-core'
* splitModel('libraryEntries', { resourceCase: kebab })
* // [ 'libraryEntries', 'library-entries' ]
*
* splitModel('libraryEntries', { resourceCase: snake })
* // [ 'libraryEntries', 'library_entries' ]
*/
export function splitModel(url: string, options?: {
resourceCase?: Function;
pluralModel?: Function;
}): [string, string];