Skip to content
Jonas Pfalzgraf edited this page Jul 20, 2022 · 2 revisions

Welcome to the FriendlyHelper wiki!

This Wiki is the result of too much free time and the need to document the bare minimum of the capabilities of the code. It is designed to give an overview and advise how to implement the different endpoints for your own project.

Installation

npm i friendly-helper

After the installation via NPM, you need to implement the main endpoint in one of the following ways:

import { FriendlyHelper } from 'friendly-helper';

import { Helper } from 'friendly-helper';

import { H } from 'friendly-helper';

Table of contents

References

  • [H]

Classes

  • Helper
  • Person
  • XmlElement

Type Aliases

  • PersonProperties
  • imageType

References

H

Renames and re-exports Helper

Type Aliases

PersonProperties

Ƭ PersonProperties: Object

Type for the person properties.

Export

Interface

PersonProperties

Type declaration

Name Type
about boolean | undefined
address boolean | undefined
age boolean | undefined
city boolean | undefined
company boolean | undefined
country boolean | undefined
email boolean | undefined
firstName boolean | undefined
fullName boolean | undefined
id boolean | undefined
jobTitle boolean | undefined
lastName boolean | undefined
phone boolean | undefined
state boolean | undefined
zip boolean | undefined

Defined in

types/personProperties.type.ts:7


imageType

Ƭ imageType: "image/png" | "image/jpeg" | "image/gif" | "image/bmp" | "image/webp" | "image/svg+xml" | "image/tiff" | "image/x-icon" | "image/avif"

Defined in

types/image.type.ts:1

Type declaration

Name Type
FriendlyHelper typeof FriendlyHelper

Defined in

FriendlyHelper.ts:119