vcard4/lib/esm/parameters/LevelParameter.d.ts

An RFC 6350 compliant JavaScript library for generating and parsing version 4.0 vCards. Can also generate RFC 6351 compliant XML vCards and RFC 7095 compliant jCards. TypeScript type declarations are provided.

import { BaseParameter } from './BaseParameter.js';
import { ParameterValueType } from '../values/ParameterValueType.js';
import '../values/BaseValue.js';

/**
 * Represents the "LEVEL" parameter
 * For use with "EXPERTISE", "HOBBY" and "INTEREST" properties
 * Used to indicate a level of expertise, hobby, or interest attained by the
 * object the vCard represents.
 */
declare class LevelParameter extends BaseParameter {
  /**
   * @param targetProp - case insensitive string specifying the target
   * property. Its value should be either "ExpertiseProperty", "HobbyProperty"
   * or "InterestProperty"
   *
   * @param levelValue - the value of the `ParameterValueType` instance should be either
   * "beginner", "average", "expert", "high", "medium" or "low", depending on
   * the value of the `targetProp` argument.
   * When the `targetProp` is "ExpertiseProperty", the only valid values are
   * "beginner", "average" and "expert".
   * When the `targetProp` is either "HobbyProperty" or "InterestProperty", the
   * only valid values are "high", "medium" and "low".
   */
  constructor(targetProp: string, levelValue: ParameterValueType);
}

export { LevelParameter };