zellige.js
Version:
A Moroccan utility library for working with CIN, phone numbers, currency, addresses, dates, and more.
20 lines (19 loc) • 532 B
TypeScript
import type { CINMetadata } from '../types/cin';
/**
* Extracts region and sequence information from a valid CIN
*
* @param cin - The CIN string to analyze
* @returns Object containing region and sequence information, or null if CIN is invalid
*
* @example
* ```typescript
* extractCINMetadata('A123456');
* // Returns {
* // region: 'Rabat',
* // sequence: '123456'
* // }
*
* extractCINMetadata('invalid'); // Returns null
* ```
*/
export declare function extractCINMetadata(cin: unknown): CINMetadata | null;