Skip to main content Link Search Menu Expand Document (external link)

Geolocation overview

Added in v1.0.0


Table of contents


accessors

watchPosition

Signature

export declare const watchPosition: (
  options?: (PositionOptions & { readonly bufferSize?: number | undefined }) | undefined
) => Stream.Stream<GeolocationPosition, GeolocationError, Geolocation>

Added in v1.0.0

errors

GeolocationError (class)

Signature

export declare class GeolocationError

Added in v1.0.0

layers

layer

Signature

export declare const layer: Layer.Layer<Geolocation>

Added in v1.0.0

models

Geolocation (interface)

Signature

export interface Geolocation {
  readonly [TypeId]: TypeId
  readonly getCurrentPosition: (
    options?: PositionOptions | undefined
  ) => Effect.Effect<GeolocationPosition, GeolocationError>
  readonly watchPosition: (
    options?:
      | (PositionOptions & {
          readonly bufferSize?: number | undefined
        })
      | undefined
  ) => Stream.Stream<GeolocationPosition, GeolocationError>
}

Added in v1.0.0

tags

Geolocation

Signature

export declare const Geolocation: Context.Tag<Geolocation, Geolocation>

Added in v1.0.0

type ids

ErrorTypeId

Signature

export declare const ErrorTypeId: typeof ErrorTypeId

Added in v1.0.0

ErrorTypeId (type alias)

Signature

export type ErrorTypeId = typeof ErrorTypeId

Added in v1.0.0

TypeId

Signature

export declare const TypeId: typeof TypeId

Added in v1.0.0

TypeId (type alias)

Signature

export type TypeId = typeof TypeId

Added in v1.0.0