Header menu logo Nu

Address Module

Address functions.

Functions and values

Function or value Description

Address.allButLast address

Full Usage: Address.allButLast address

Parameters:
Returns: 'b Address

Take an address composed of all but the last name of an address.

address : 'a Address
Returns: 'b Address

Address.anonymize address

Full Usage: Address.anonymize address

Parameters:
Returns: 'a Address

Anonymize an address.

address : 'a Address
Returns: 'a Address

Address.changeType address

Full Usage: Address.changeType address

Parameters:
Returns: 'b Address

Change the type of an address.

address : 'a Address
Returns: 'b Address

Address.empty

Full Usage: Address.empty

Returns: 'a Address

The empty address.

Returns: 'a Address

Address.equals left right

Full Usage: Address.equals left right

Parameters:
Returns: bool

Test address equality.

left : 'a Address
right : 'a Address
Returns: bool

Address.findIndex finder address

Full Usage: Address.findIndex finder address

Parameters:
    finder : string -> bool
    address : 'a Address

Returns: int

Find the index of a name

finder : string -> bool
address : 'a Address
Returns: int

Address.getHashCode address

Full Usage: Address.getHashCode address

Parameters:
Returns: int

Get the address's hash code.

address : 'a Address
Returns: int

Address.getName address

Full Usage: Address.getName address

Parameters:
Returns: string
Modifiers: inline
Type parameters: 'a

Get the name of an address.

address : 'a Address
Returns: string

Address.getNames address

Full Usage: Address.getNames address

Parameters:
Returns: string array
Modifiers: inline
Type parameters: 'a

Get the names of an address.

address : 'a Address
Returns: string array

Address.head address

Full Usage: Address.head address

Parameters:
Returns: string

Take the head of an address.

address : 'a Address
Returns: string

Address.indexOf name address

Full Usage: Address.indexOf name address

Parameters:
    name : string
    address : 'a Address

Returns: int

Find the index of a name

name : string
address : 'a Address
Returns: int

Address.isEmpty address

Full Usage: Address.isEmpty address

Parameters:
Returns: bool

Check that an address is devoid of names.

address : 'a Address
Returns: bool

Address.item index address

Full Usage: Address.item index address

Parameters:
Returns: string

Take a name of an address.

index : int
address : 'a Address
Returns: string

Address.last address

Full Usage: Address.last address

Parameters:
Returns: string

Take the last name of an address.

address : 'a Address
Returns: string

Address.length address

Full Usage: Address.length address

Parameters:
Returns: int

Get the length of an address by its names.

address : 'a Address
Returns: int

Address.makeFromArray names

Full Usage: Address.makeFromArray names

Parameters:
    names : string array

Returns: 'a Address

Make an address from a list of names.

names : string array
Returns: 'a Address

Address.makeFromInterface address

Full Usage: Address.makeFromInterface address

Parameters:
Returns: 'a Address

Convert a weakly-typed Address interface into a strongly-typed address.

address : Address
Returns: 'a Address

Address.makeFromList names

Full Usage: Address.makeFromList names

Parameters:
    names : string list

Returns: 'a Address

Make an address from a list of names.

names : string list
Returns: 'a Address

Address.makeFromName name

Full Usage: Address.makeFromName name

Parameters:
    name : string

Returns: 'a Address

Make an address from a name.

name : string
Returns: 'a Address

Address.makeFromSeq names

Full Usage: Address.makeFromSeq names

Parameters:
    names : string seq

Returns: 'a Address

Make an address from a sequence of names.

names : string seq
Returns: 'a Address

Address.notEmpty address

Full Usage: Address.notEmpty address

Parameters:
Returns: bool

Check that an address has one or more names.

address : 'a Address
Returns: bool

Address.skip n address

Full Usage: Address.skip n address

Parameters:
Returns: 'b Address

Take an address composed of the name of an address minus a skipped amount of names.

n : int
address : 'a Address
Returns: 'b Address

Address.tail address

Full Usage: Address.tail address

Parameters:
Returns: 'b Address

Take the tail of an address.

address : 'a Address
Returns: 'b Address

Address.take n address

Full Usage: Address.take n address

Parameters:
Returns: 'b Address

Take an address composed of the given number of names of an address.

n : int
address : 'a Address
Returns: 'b Address

Address.tryGetName address

Full Usage: Address.tryGetName address

Parameters:
Returns: string option

Attempt to get the name of an address if it exists.

address : 'a Address
Returns: string option

Address.tryTake n address

Full Usage: Address.tryTake n address

Parameters:
Returns: 'b Address

Take an address composed of the given number of names of an address.

n : int
address : 'a Address
Returns: 'b Address

Address.validName name

Full Usage: Address.validName name

Parameters:
    name : string

Returns: bool

Check that a string represents a valid address name.

name : string
Returns: bool

Type something to start searching.